Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
COSMOS Document Naming
Revision as of 10:18, 5 February 2008 by Vasconi.us.ibm.com (Talk | contribs) (→Hierarchy of documentation categories example)
COSMOS Wiki > COSMOS Document Plan
Contents
Document naming
Hi, I am open for suggestions in defining the best way to name our COSMOS documentation on our Wiki pages.
Document coordinator
Richard Vasconi vasconi@us.ibm.com
When creating a Wiki document page, please 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: Componets
- 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.