Difference between revisions of "Editing the Wiki"
Poofjunior (talk | contribs) |
Poofjunior (talk | contribs) |
||
| Line 1: | Line 1: | ||
| + | All are welcome to edit the wiki, but do read these guidelines first, or your changes may be reverted! | ||
| + | |||
| + | ==Wiki Goals== | ||
| + | The primary goal of the wiki is the creation and sharing of knowledge related to working with Jubilee. | ||
| + | |||
==Syntax== | ==Syntax== | ||
| + | The Jubilee Wiki uses the MediaWiki syntax, and a series of plugins or ''widgets'' to offer special conveniences like code boxes, etc. | ||
| + | |||
| + | ==Voice== | ||
| + | ===Inclusivity=== | ||
| + | At all costs, avoid statements that are racist, sexist, homophobic, transphobic, culturally insensitive, or express hatred in any way. | ||
| + | |||
| + | ===Normative Stamements=== | ||
| + | Avoid [https://en.wikipedia.org/wiki/Normative_statement normative statements] where possible. A normative statement is a statement that expresses a value judgement. | ||
| + | |||
| + | Example: ''You should ..'' | ||
| + | |||
| + | Example: ''garbage crimp connectors'' | ||
| + | |||
| + | Example: ''MIC6 Aluminum is better than 6061 aluminium'' | ||
| + | |||
| + | Instead, in the case where you, the author, feels this way, try to unpack why you feel that way, and lay out your reasoning. In the example above about MIC6 aluminum, what makes it better? What characteristics related to both the situation and the material make it a better choice? | ||
==Wiki Conventions== | ==Wiki Conventions== | ||
Revision as of 14:10, 12 May 2020
All are welcome to edit the wiki, but do read these guidelines first, or your changes may be reverted!
Wiki Goals
The primary goal of the wiki is the creation and sharing of knowledge related to working with Jubilee.
Syntax
The Jubilee Wiki uses the MediaWiki syntax, and a series of plugins or widgets to offer special conveniences like code boxes, etc.
Voice
Inclusivity
At all costs, avoid statements that are racist, sexist, homophobic, transphobic, culturally insensitive, or express hatred in any way.
Normative Stamements
Avoid normative statements where possible. A normative statement is a statement that expresses a value judgement.
Example: You should ..
Example: garbage crimp connectors
Example: MIC6 Aluminum is better than 6061 aluminium
Instead, in the case where you, the author, feels this way, try to unpack why you feel that way, and lay out your reasoning. In the example above about MIC6 aluminum, what makes it better? What characteristics related to both the situation and the material make it a better choice?
Wiki Conventions
Project Versions
The wiki will always reference the most up-to-date version of the project. Information related to older versions should (1) either explicitly mention this up front or (2) create and older page and link to it from the current page.
Links and Uploads
Design Files
Design files are subject to change between versions. As such, do not upload design files directly to the wiki. Instead, link them to the file in the master branch of the project repository.
Exception: aesthetic-only or placeholder images that clearly point to the most up-to-date version are OK.
PDFs hosted on Github
Links to PDFs hosted on Github will redirect to a github rendering of the PDF as a PNG image on Github's website. This isn't really ideal. As a workaround, we can modify the link to get Google's PDF doc viewer to render it cleanly in a format that can be readily printed. To do this, prefix the github URL with the following:
https://docs.google.com/viewer?url=
Then, in the url, change blob to raw. When the page is saved, the result should be a link that, when clicked presents a preview of the PDF as if it were ready to be printed.