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.
Difference between revisions of "OHF Wiki Policies"
(→Naming) |
(→Content) |
||
| Line 1: | Line 1: | ||
== Content == | == Content == | ||
| + | The OHF Wiki is intended for use by developers and advanced users that are interested in the underlying architecture of OHF as well those looking to contribute to OHF. Content that is designed for end-users only (i.e. install documents, basic configuration documents) should be placed on the component-specific pages of the main OHF Web site. | ||
| + | |||
| + | It is strongly recommended that content creators keep a strict separation of content between the main Web site and Wiki for the sake of consistency. Please consider the content that you are writing before deciding whether it should go on the Wiki or Web site. A good rule of thumb is balance long-term static content vs. content that will change often. This often ties directly into the notion of public release versus unstable release of code. For example, if you are writing an install guide for a public release of your component, it is better suited to be on the main Web page, as it is primarily intended for end users and will not be modified often. On the other hand, if you are composing the next-generation architecture of your component, it will likely be modified repeatedly and fits more into a Wiki paradigm. | ||
| + | |||
== Naming == | == Naming == | ||
The Eclipse OHF Wiki is co-located in the same namespace as all other Eclipse project content. To ensure consistency, all OHF content pages should be prefixed with the letters 'OHF'. For component-specific pages, the component name should also be prefixed. For example, all pages relating to the IHE components of OHF will be prefixed with 'OHF IHE'. If you encounter a page belonging to OHF that does not follow this naming convention, please use the MediaWiki '''move''' function to make it conform and update the originating link. | The Eclipse OHF Wiki is co-located in the same namespace as all other Eclipse project content. To ensure consistency, all OHF content pages should be prefixed with the letters 'OHF'. For component-specific pages, the component name should also be prefixed. For example, all pages relating to the IHE components of OHF will be prefixed with 'OHF IHE'. If you encounter a page belonging to OHF that does not follow this naming convention, please use the MediaWiki '''move''' function to make it conform and update the originating link. | ||
Revision as of 18:06, 27 June 2007
Content
The OHF Wiki is intended for use by developers and advanced users that are interested in the underlying architecture of OHF as well those looking to contribute to OHF. Content that is designed for end-users only (i.e. install documents, basic configuration documents) should be placed on the component-specific pages of the main OHF Web site.
It is strongly recommended that content creators keep a strict separation of content between the main Web site and Wiki for the sake of consistency. Please consider the content that you are writing before deciding whether it should go on the Wiki or Web site. A good rule of thumb is balance long-term static content vs. content that will change often. This often ties directly into the notion of public release versus unstable release of code. For example, if you are writing an install guide for a public release of your component, it is better suited to be on the main Web page, as it is primarily intended for end users and will not be modified often. On the other hand, if you are composing the next-generation architecture of your component, it will likely be modified repeatedly and fits more into a Wiki paradigm.
Naming
The Eclipse OHF Wiki is co-located in the same namespace as all other Eclipse project content. To ensure consistency, all OHF content pages should be prefixed with the letters 'OHF'. For component-specific pages, the component name should also be prefixed. For example, all pages relating to the IHE components of OHF will be prefixed with 'OHF IHE'. If you encounter a page belonging to OHF that does not follow this naming convention, please use the MediaWiki move function to make it conform and update the originating link.