Authoring guidelines

Qui peut contribuer à ce wiki?

Toute personne qui détient un compte Calcul Canada peut contribuer à ce wiki. La tâche de veiller à l'intégrité du contenu revient à l'équipe Calcul Canada. Nous sommes cependant à l'ère Wikipédia et le lecteur est invité à corriger toute erreur flagrante, soit un lien brisé ou une faute de frappe. Un de vos utilisateurs pourrait écrire une page entière, par exemple sur un logiciel qu'il connait mieux que vous. Une fois l'information affichée, nous la réviserons pour nous assurer qu'elle est conforme à nos principes directeurs.

Il n'est pas possible de modifier le contenu de façon anonyme: vous devez vous connecter en utilisant les coordonnées de votre compte Calcul Canada. Nous pouvons ainsi connaitre l'origine des modifications.

Quel type d'information publier sur ce wiki?

Ce wiki n'est pas l'endroit où publier l'information qui relève de la compétence de l'équipe de direction de Calcul Canada et particulièrement de celle de la directrice administrative des affaires extérieures (ci-après, la Directrice). Est donc exclue toute information destinée au public, aux médias et aux agences de financement. Ce wiki se veut un lieu de documentation technique; le matériel de formation ou de publicité n'y a pas sa place. Avant de publier ou de modifier une page, posez-vous les questions suivantes&nbsp:

• &nbspL'information est-elle en rapport avec les services ou les équipements offerts par l'organisation? Si c'est le cas, cette information est-elle publiquement disponible? Autrement, consultez la Directrice avant publication.
• &nbspS'il s'agit de renseignements en rapport avec l'état d'un équipement sujet à changer à très court terme (par exemple disponible, hors réseau, en réparation), la responsabilité en revient probablement à l'équipe de surveillance.
• &nbspL'information s'adresse-t-elle aux utilisateurs plutôt qu'à une équipe technique de Calcul Canada? Si elle est destinée à une équipe technique, elle devrait se trouver sur https://ccdb.computecanada.ca/wiki/ plutôt que sur https://docs.computecanada.ca/wiki/.
• &nbspL'information a-t-elle un lien quelconque avec la sécurité de nos données ou de nos systèmes? Si c'est le cas, consultez le directeur de la sécurité de l'information avant publication.
• L'information est-elle destinée à un type d'utilisateur particulier? Il y a ici une zone grise&nbsp: tout comme les détenteurs de comptes en bonne et due forme, les utilisateurs potentiels ont parfois besoin de renseignements sur nos services et nos installations. Si l'information s'adresse à un utilisateur potentiel, elle doit être publiée sur https://computecanada.ca plutôt que sur https://docs.computecanada.ca/wiki/.
  • &nbspIl est parfois indiqué d'inclure un hyperlien (par exemple, Voir&lsquoObtenir un compte&rsquo).
• &nbspLes renseignements décrivent-ils comment utiliser un service, une grappe ou une application? Si oui, vous êtes au bon endroit.

Style guidelines

If in doubt, imitate the masters. Look at an existing page you like and follow the style. If there isn’t one at docs.computecanada.ca, look for one at Wikipedia.

• Separate graphic design from content as much as possible. Don’t use extra line breaks to adjust vertical spacing. Don’t indent paragraphs with tabs or spaces or add extra spaces after a sentence. If we want to make any such style adjustments we will make them universally using stylesheets and templates.
• Screen shots are good, especially in how-tos and tutorials. But full-sized screen shots interrupt the structure and flow of the text if they’re placed in-line. Let them float to the right-hand side. Also, scale the image down. If that makes important information unreadable, maybe a cropped picture is better? Or, remind the reader in the caption that they can "Click on the image for a larger version."
• Minimize use of synonyms. Yes, it makes the text less boring, but for a new user or one reading in a second language, interchangeable terms (e.g. "machine", "host", "node", "server") may be confusing.
• Leave one blank line at the end of each section before the following header. The translation package uses the blank line and header to determine the boundaries of translation units.

Templates

There are multiple templates, available. Please use them as appropriate. Of particular interests are templates for Including a command within the wiki and for Including a source code file within the wiki.

Translation

Page Translation.