Difference between revisions of "Manual of Style"

From wikieduonline
Jump to navigation Jump to search
Line 6: Line 6:
 
* All commands and commands output should use the following format: <nowiki><code>your_command_goes_here</code></nowiki>
 
* All commands and commands output should use the following format: <nowiki><code>your_command_goes_here</code></nowiki>
 
** Output: <code>your_command_goes_here</code>
 
** Output: <code>your_command_goes_here</code>
 +
* All the large outputs should use the following format, example:
 +
** <pre>aws eks list-clusters
 +
{
 +
    "clusters": []
 +
}</pre>
 
* Tittle from commands has to go in lowercase, use <nowiki>{{lc}}</nowiki> template.
 
* Tittle from commands has to go in lowercase, use <nowiki>{{lc}}</nowiki> template.
 
* Allways check if the page exist, in case does not exist you will need to add a redirect link:  
 
* Allways check if the page exist, in case does not exist you will need to add a redirect link:  
 
** Example: #redirect [[gsutil acl ch]]   
 
** Example: #redirect [[gsutil acl ch]]   
 
* Use == or === to create sub titles
 
* Use == or === to create sub titles
 +
 
== Related ==
 
== Related ==
 
* [[TODO]]
 
* [[TODO]]

Revision as of 09:15, 1 August 2022

  • Link to internal pages are always encouraged
  • All pages should contain a Category and See also section
  • Allways use templates on See also section
  • AWS command pages should include a link to v2 command, update if v1 link present.
  • All commands and commands output should use the following format: <code>your_command_goes_here</code>
    • Output: your_command_goes_here
  • All the large outputs should use the following format, example:
    • aws eks list-clusters

{

   "clusters": []

}

  • Tittle from commands has to go in lowercase, use {{lc}} template.
  • Allways check if the page exist, in case does not exist you will need to add a redirect link:
  • Use == or === to create sub titles

Related

See also

Advertising: