Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 1790615

Summary: AppStream (formerly AppData) packaging guidelines use outdated terms and example code
Product: [Retired] Fedora Documentation Reporter: Audrey Yeena Toskin <audrey>
Component: packager-guideAssignee: Petr Bokoc <pbokoc>
Status: CLOSED EOL QA Contact: Fedora Docs QA <docs-qa>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: develCC: pkovar
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: ---
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2024-05-21 09:23:37 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Audrey Yeena Toskin 2020-01-13 18:31:11 UTC
I'm referring to the docs at "Packaging Guidelines for AppData Files"
<https://docs.fedoraproject.org/en-US/packaging-guidelines/AppData/>

The AppStream project has made a number of changes since these Fedora guidelines were written, and the conflicting information confused me at first, as I looked up how to add AppStream metadata to a new package I'm working on...

* In the Fedora guidelines, the second sentence
  ("Installed .appdata.xml files MUST follow the AppData specification page.")
  links to 
  <http://people.freedesktop.org/~hughsient/appdata/>
  but this URL now redirects to
  <https://www.freedesktop.org/software/appstream/docs/chap-Quickstart.html#sect-Quickstart-DesktopApps>

* As far as I can tell, the AppStream specification no longer
  uses the filename to distinguish between applications and
  addons, and all AppStream metadata files should now be named
  .metainfo.xml. Files for GUI applications are no longer named
  .appdata.xml.
  See <https://www.freedesktop.org/software/appstream/docs/chap-Quickstart.html#sect-Quickstart-DesktopApps>

* The example .appdata.xml file in the Fedora guidelines is
  therefore also out of date. The current AppStream spec,
  for example, states that the component type should be
  "desktop-application" instead of just "desktop".

Unless I'm misunderstanding something, the Fedora guidelines here will need to be rewritten somewhat.

Comment 1 Petr Bokoc 2024-05-21 09:23:37 UTC
This guide has been retired, therefore I'm closing this bug. 

If you would like to report Fedora docs bugs in the future, please use the "bug" icon on the top right of the affected page, it will take you directly to the appropriate issue tracker.