Translations:Authoring guidelines/3/en: Difference between revisions

From Alliance Doc
Jump to navigation Jump to search
No edit summary
(Importing a new version from external source)
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
==Quel type d'information publier sur ce wiki?==
== What belongs on this 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:
This Wiki is not the place for information that properly belongs in the purview of the Alliance communications team, which includes any communications intended for the general public, media, or funding agencies. Materials related to training and outreach also don’t belong on this technical documentation site. To that end, ask yourself before you publish a page or make a change:
*&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? Pour les autres cas, consultez la Directrice avant publication.
* Is this about what services or clusters are available? If so, has the service or cluster already been announced? If not, consult the the Senior Manager, Communications & Marketing before publishing.  
*&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.
* Status information which changes from day to day --- available, offline, in maintenance, etc.--- belongs on https://status.alliancecan.ca/.
*&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/.''
* Is this information useful to a user, as opposed to other CC technical staff? If technical staff, then it might belong at https://wiki.computecanada.ca/staff/ rather than https://docs.alliancecan.ca/.
*&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.
* Does the information have implications for the security of our systems, or security of data on our systems? If so, consult the Director of Cybersecurity before publishing.
*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/.''
* Is the information of interest only to a prospective user, as opposed to an existing account-holder? This is a gray area: A prospective user might want to know technical details about our services and facilities, the same as an account-holder, but if the information is only of interest to a prospective user then it properly belongs on https://www.alliancecan.ca rather than https://docs.alliancecan.ca/.  
**&nbspIl est parfois indiqué d'inclure un hyperlien (par exemple, Voir&lsquoObtenir un compte&rsquo).
* External links may be appropriate, see e.g. "Getting an Account".
*&nbspLes renseignements décrivent-ils comment utiliser un service, une grappe ou une application? Si oui, vous êtes au bon endroit.
* Is this about how to use an existing service, cluster, or application? If so, go ahead.
If you still have any doubt, staff members should use the #rsnt-documentation channel in Slack. Non-staff contributors should contact [[Technical support]].

Latest revision as of 15:32, 26 July 2023

Information about message (contribute)
This message has no documentation. If you know where or how this message is used, you can help other translators by adding documentation to this message.
Message definition (Authoring guidelines)
== What belongs on this Wiki? ==
This Wiki is not the place for information that properly belongs in the purview of the Alliance communications team, which includes any communications intended for the general public, media, or funding agencies. Materials related to training and outreach also don’t belong on this technical documentation site. To that end, ask yourself before you publish a page or make a change:
* Is this about what services or clusters are available? If so, has the service or cluster already been announced? If not, consult the the Senior Manager, Communications & Marketing before publishing. 
* Status information which changes from day to day --- available, offline, in maintenance, etc.--- belongs on https://status.alliancecan.ca/.
* Is this information useful to a user, as opposed to other CC technical staff? If technical staff, then it might belong at https://wiki.computecanada.ca/staff/ rather than https://docs.alliancecan.ca/.
* Does the information have implications for the security of our systems, or security of data on our systems? If so, consult the Director of Cybersecurity before publishing.
* Is the information of interest only to a prospective user, as opposed to an existing account-holder? This is a gray area: A prospective user might want to know technical details about our services and facilities, the same as an account-holder, but if the information is only of interest to a prospective user then it properly belongs on https://www.alliancecan.ca rather than https://docs.alliancecan.ca/. 
* External links may be appropriate, see e.g. "Getting an Account".
* Is this about how to use an existing service, cluster, or application? If so, go ahead.
If you still have any doubt, staff members should use the #rsnt-documentation channel in Slack. Non-staff contributors should contact [[Technical support]].

What belongs on this Wiki?

This Wiki is not the place for information that properly belongs in the purview of the Alliance communications team, which includes any communications intended for the general public, media, or funding agencies. Materials related to training and outreach also don’t belong on this technical documentation site. To that end, ask yourself before you publish a page or make a change:

  • Is this about what services or clusters are available? If so, has the service or cluster already been announced? If not, consult the the Senior Manager, Communications & Marketing before publishing.
  • Status information which changes from day to day --- available, offline, in maintenance, etc.--- belongs on https://status.alliancecan.ca/.
  • Is this information useful to a user, as opposed to other CC technical staff? If technical staff, then it might belong at https://wiki.computecanada.ca/staff/ rather than https://docs.alliancecan.ca/.
  • Does the information have implications for the security of our systems, or security of data on our systems? If so, consult the Director of Cybersecurity before publishing.
  • Is the information of interest only to a prospective user, as opposed to an existing account-holder? This is a gray area: A prospective user might want to know technical details about our services and facilities, the same as an account-holder, but if the information is only of interest to a prospective user then it properly belongs on https://www.alliancecan.ca rather than https://docs.alliancecan.ca/.
  • External links may be appropriate, see e.g. "Getting an Account".
  • Is this about how to use an existing service, cluster, or application? If so, go ahead.

If you still have any doubt, staff members should use the #rsnt-documentation channel in Slack. Non-staff contributors should contact Technical support.