#54 Docs link to wrong version of modulemd spec
Closed 5 years ago by asamalik. Opened 5 years ago by mbooth.

This page: https://docs.fedoraproject.org/en-US/modularity/making-modules/defining-modules/

Contains a link to this page: https://github.com/fedora-modularity/libmodulemd/blob/master/spec.v2.yaml

However after hours of scratching my head attempting to use features that are described by this version of the modulemd spec, I discovered that this is not the version of the modulemd spec that is currently supported by MBS.

Please fix the link in the modularity docs to show which version of the spec is supported by MBS because the current link is misleading.


We've discussed this recently on IRC and agreed that we shouldn't have the link there at all.

The upstream has new features that are not necessarily ready for use in Fedora — by either development readiness or policy restrictions.

People should refer only to the Defining modules in modulemd page you've linked as guidelines instead. The Modularity team will make sure that the page is up-to-date, and containing only relevant information about things that actually work.

I've just pushed an update to the docs.

Metadata Update from @asamalik:
- Issue status updated to: Closed (was: Open)

5 years ago

Metadata Update from @asamalik:
- Issue assigned to asamalik

5 years ago

Thanks for fixing, hopefully this prevents other people from being similarly confused :-)

Login to comment on this ticket.

Metadata