Jump to: navigation, search

Difference between revisions of "Platform-releng/conventions for releng wiki pages"

(starting sub category for platfrom releng related pages)
 
(Conventions used to add wiki pages for Eclipse Platform Releng)
 
(One intermediate revision by the same user not shown)
Line 3: Line 3:
 
The following are some rough suggestions or guidelines.  
 
The following are some rough suggestions or guidelines.  
  
 +
== Categorization ==
 
To add a page to the ''Eclipse Platform Releng'' category, add the following to the bottom of that page:  
 
To add a page to the ''Eclipse Platform Releng'' category, add the following to the bottom of that page:  
  
 
:<nowiki>[[Category:Eclipse_Platform_Releng| ]]</nowiki>  
 
:<nowiki>[[Category:Eclipse_Platform_Releng| ]]</nowiki>  
  
Or, when appropriate, you can add to multiple categories, such as the following.  
+
Or, when appropriate, you can add to multiple categories to one page, such as the following.  
  
 
:<nowiki>[[Category:Eclipse_Project| ]][[Category:Eclipse_Platform_Releng| ]]</nowiki> or  
 
:<nowiki>[[Category:Eclipse_Project| ]][[Category:Eclipse_Platform_Releng| ]]</nowiki> or  
 
:<nowiki>[[Category:Git]][[Category:Eclipse_Platform_Releng| ]]</nowiki>
 
:<nowiki>[[Category:Git]][[Category:Eclipse_Platform_Releng| ]]</nowiki>
  
Note: when creating new documents directly related to Eclipse Platform Releng, they should also be created "under" the Platform-releng URL, to provide "bread crumb" navigation". (Which will, eventually, be redirected back to this category page). For example,  
+
== Breadcrumbs ==
 +
When creating new documents directly related to Eclipse Platform Releng, they should also be created "under" the Platform-releng URL, to provide "bread crumb" navigation". For example,  
  
 
<nowiki>http://wiki.eclipse.org/Platform-releng/<yourNewPageName></nowiki>
 
<nowiki>http://wiki.eclipse.org/Platform-releng/<yourNewPageName></nowiki>
 +
 +
== Other releng categories ==
 +
 +
Finally, to emphasize, this Eclipse Platform Releng is meant to be very specific to Platform release engineering. If a page of general release engineering information, meant for many projects at the Eclipse Foundation, then it would be more appropriate to use the more general category of
 +
 +
:<nowiki>[[Category:Releng| ]]</nowiki>
 +
  
 
[[Category:Eclipse_Platform_Releng| ]]
 
[[Category:Eclipse_Platform_Releng| ]]

Latest revision as of 20:01, 15 March 2012

Conventions used to add wiki pages for Eclipse Platform Releng

The following are some rough suggestions or guidelines.

Categorization

To add a page to the Eclipse Platform Releng category, add the following to the bottom of that page:

[[Category:Eclipse_Platform_Releng| ]]

Or, when appropriate, you can add to multiple categories to one page, such as the following.

[[Category:Eclipse_Project| ]][[Category:Eclipse_Platform_Releng| ]] or
[[Category:Git]][[Category:Eclipse_Platform_Releng| ]]

Breadcrumbs

When creating new documents directly related to Eclipse Platform Releng, they should also be created "under" the Platform-releng URL, to provide "bread crumb" navigation". For example,

http://wiki.eclipse.org/Platform-releng/<yourNewPageName>

Other releng categories

Finally, to emphasize, this Eclipse Platform Releng is meant to be very specific to Platform release engineering. If a page of general release engineering information, meant for many projects at the Eclipse Foundation, then it would be more appropriate to use the more general category of

[[Category:Releng| ]]