Bug 30383 – Step for adding metadata.xml left out

• Status: RESOLVED FIXED
• Product: [OLD] Docs-developer

[Description Rob Cakebread (RETIRED) 2003-10-05 05:40:44 UTC]

The only mention of metadata.xml is in the herds documentation. This
documentation doesn't seem to be linked to from any other developer documentation.

This documentation leaves out the step for adding metadata.xml:
http://www.gentoo.org/proj/en/devrel/new-dev-training.xml

Also, metadata.xml isn't listed in any other developer docs such as the Ebuild
HOWTO.

I'm not sure if there is some developer documentation you don't want people to
see until they become developers, but it seems there is no central page listing
all available developer documentation.

Reproducible: Always
Steps to Reproduce:
1.
2.
3.



Expected Results:  
1. An index of all devloper documentation.
2. An update of existing documentation that mentions metadata.xml

[Comment 1 Rob Cakebread (RETIRED) 2003-10-10 17:05:20 UTC]

I saw this mentioned on the gentoo-dev mailing list. It satisfies part of
this bug if a link to it is put in the New Developer guide:

http://www.gentoo.org/proj/en/gdp/doc/en/doc-issues.xml

[Comment 2 Sven Vermeulen (RETIRED) 2003-11-14 11:33:07 UTC]

We're currently in the process of linking all relevant documentation in the main documentation page, but with some extra requests which will take some time. Currently the cluster documentation is being integrated. Other documentation should follow soon(ish).

[Comment 3 Sven Vermeulen (RETIRED) 2004-02-09 12:39:45 UTC]

I'll try to get metadata-stuff documented in the proper documentation.

[Comment 4 Sven Vermeulen (RETIRED) 2004-02-10 06:57:58 UTC]

Created attachment 25340 [details]
Metadata document

This document is just a rip-off of Paul's explanation on the metastructure
project page, plus two example metadata.xml contents.

[Comment 5 Sven Vermeulen (RETIRED) 2004-02-10 07:00:46 UTC]

Paul, would you mind if I put the metadata.xml information online (http://dev.gentoo.org/~swift/metadata.html) and link to it from the development howto? I've moved it into a separate document so it can be extended with more examples easily - as I believe the metadata.xml file will probably be containing more information when time goes by.

[Comment 6 Paul de Vrieze (RETIRED) 2004-02-10 07:30:03 UTC]

I think indeed that my metadata.xml document will be extended at some point. I leave it up to you to decide what is best to do (one doc or two). I don't mind if you make such a page though. So go ahead

[Comment 7 Sven Vermeulen (RETIRED) 2004-02-10 11:44:44 UTC]

Okay I've committed the doc as http://www.gentoo.org/doc/en/metadata.xml. Before I'd link it to any dev-doc, I'd like to know from others if there is more information needed about metadata? The first part is a bit referential, but the second one (the examples) should really make it easy for developers to understand.

[Comment 8 Sven Vermeulen (RETIRED) 2004-02-12 01:17:26 UTC]

Reassigning to avenj.

Jon, can you link and/or write up a small paragraph on metadata.xml in new-dev-training.xml?

[Comment 9 Jon Portnoy (RETIRED) 2004-03-01 11:55:36 UTC]

Added a link to the metadata doc.