Ticket #581 (closed defect: fixed)
Metadata documentation tweaks
| Reported by: | [email protected]… | Owned by: | solj |
|---|---|---|---|
| Priority: | trivial | Milestone: | Bcfg2 1.0.0 Release |
| Component: | bcfg2-doc | Version: | |
| Keywords: | metadata | Cc: |
Description
Metadata specification is documented here: WritingSpecification?#Metadataclients.xml
The 'client tag' chart is missing some elements that are described on the Authentication? page; it would be handy to have a link (in both directions!)
On the Authentication page, it might be handy to point out that the 'uuid' should correspond to the value of the 'name' parameter in the client's bcfg2.conf.
Also, I'd rather the 'client tag' chart be documented on the Metadata? page so I can find it easily through the index without having to think (ouchy). The groups chart is also split between the WritingSpecification? and Metadata pages. In fact, the Metadata plugin is the only one whose specification's main documentation is in the WritingSpecification? page. (And if the Xinclude stuff on the WritingSpec? page only applies to Metadata, it should be moved along with the Metadata docs.)
Attachments
Change History
comment:1 Changed 14 years ago by solj
- Owner changed from desai to solj
- Status changed from new to assigned
- Milestone set to Bcfg2 1.0 Release
comment:2 in reply to: ↑ description Changed 14 years ago by solj
- Status changed from assigned to closed
- Resolution set to fixed
Replying to [email protected]:
Metadata specification is documented here: WritingSpecification?#Metadataclients.xml
The 'client tag' chart is missing some elements that are described on the Authentication? page; it would be handy to have a link (in both directions!)
This has been added.
On the Authentication page, it might be handy to point out that the 'uuid' should correspond to the value of the 'name' parameter in the client's bcfg2.conf.
Also, I'd rather the 'client tag' chart be documented on the Metadata? page so I can find it easily through the index without having to think (ouchy). The groups chart is also split between the WritingSpecification? and Metadata pages. In fact, the Metadata plugin is the only one whose specification's main documentation is in the WritingSpecification? page. (And if the Xinclude stuff on the WritingSpec? page only applies to Metadata, it should be moved along with the Metadata docs.)
All of this has been updated. The Metadata page has been moved to here? in order to make it easy to find (along with all the other Bcfg2 Server Plugins).
