User Tools

Site Tools


realtime:edit_guideline

Some simple rules for editors

First of all a account with write access to the Real-Time Linux WIKI needs to be created. Before editing please be sure to consider the general rules, to have an idea about the structure of the WIKI (especially when creating new pages), and to respect the content guidelines.


How to create an account

In order to create an account with write access to the Real-Time Linux WIKI, take the following steps:

  • Register on the site for permissions to login: Click on Login/Register at top right and fill in registration if you don't already have an id.
  • Visit https://support.linuxfoundation.org and log in with your Linux Foundation ID (LFID) username and password. Select “Project Services” and then “Additional permissions”. Select the “Real Time Linux” project and then ask for edit permission for the Real-Time Linux WIKI and provide your login id.
  • When you get confirmation back (usually in a day), make sure to log out, and then log back in again.

General Editing Rules

Please consider the following simple rules when editing:

  • Treat others with respect and civility
  • Keep the writing objective and factual, and not opinionated please
  • Do not infringe copyright
  • Cite and if you cite, please cite the correct way
  • No promoting products or services

Content Rules

The content in this WIKI represents state of the art. This means, all information about features and characteristics of the currently supported PREEMPT_RT patch versions should be carried together in this WIKI. Hints for PREEMPT_RT patch versions, that will be one day no longer state of the art, can be left there as history if they are important. Otherwise they should be removed.

For currently supported versions please refer to PREEMPT_RT versions.

Please do not duplicate content (hosted in this wiki or somewhere else) - make links instead; this doesn't apply to content of the old RT-Wiki.

Layout

The pages of this WIKI are organized in categories with several subcategories. For a detailed overview of the structure please have a look at the Sitemap.

  • communication (all communication channels are described)
  • documentation (howtos, technical documentation)
  • events
  • rtl (all Real-Time Linux Project specific information)

The page structure should be consistent over the whole WIKI: The main pages give an overview with short teasers describing the different topics. The link to the more detailed description of a topic is flushed right. The page layout of the WIKI is structured with the dokuwiki WRAP plugin. Dokuwiki offers a default main page for every category (category is also known as namespace). This is the page “start” in the specific category. Content added to FAQ pages should be in question and answer format.

realtime/edit_guideline.txt · Last modified: 2021/12/02 17:20 by bartwensley