Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "COSMOS Document Naming"
(→Hierarchy of documentation categories example) |
(→Document naming) |
||
Line 2: | Line 2: | ||
== Document naming == | == Document naming == | ||
− | + | ||
− | + | When creating a Wiki document page, use the following naming structure: | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | When creating a Wiki document page, | + | |
* '''wiki.eclipse.org/COSMOS_Users's_Guide_{topic}''' | * '''wiki.eclipse.org/COSMOS_Users's_Guide_{topic}''' | ||
Line 17: | Line 9: | ||
Where '''''{topic}''''' is the name of the COSMOS component or subject, for example: | Where '''''{topic}''''' is the name of the COSMOS component or subject, for example: | ||
− | + | The following items are a few topics of the COSMOS User's Guide. | |
+ | |||
+ | |||
* Overview | * Overview | ||
* Management Enablement | * Management Enablement |
Revision as of 15:54, 5 February 2008
COSMOS Wiki > COSMOS Document Plan
Contents
Document naming
When creating a Wiki document page, use the following naming structure:
- wiki.eclipse.org/COSMOS_Users's_Guide_{topic}
- or wiki.eclipse.org/COSMOS_Development_Guide_{topic}
Where {topic} is the name of the COSMOS component or subject, for example: The following items are a few topics of the COSMOS User's Guide.
- Overview
- Management Enablement
- WSDM_tooling
Naming examples:
- COSMOS_User's_Guide_Management_Enablement
Adding a Category documentation reference
To help organize and locate documents, please insert the following category tag at the bottom of your document Wiki page:
'''[[Category:COSMOS Consumer Documentation]]'''
Hierarchy of documentation categories example
[[Category:COSMOS]] .... [[Category:COSMOS Consumer Documentation]] ............ [[Category:COSMOS User's Guide]] ............ [[Category:COSMOS Development Guide]]To make
[[Category:COSMOS User's Guide]]a child of
[[Category:COSMOS Consumer Documentation]], just edit wiki.eclipse.org/Category:COSMOS_User's_Guide and put
[[Category:COSMOS Consumer Documentation]]at the bottom of the page, and submit the change.