Help us work towards ensuring May First documentation is a useful source of information for May First members and our movements.
Before you begin please read more about how we intend to organize documentation.
These notes provide helpful guidelines for writing any documentation page but might be especially useful for writing how-tos and tutorials.
Be sure to consult our style guide.
Please login to our Discourse forum then join our working group and request wiki access in this thread.
You may also contact May First staff via email
See the How to edit pages in WikiJS documentation to get a general overview of how to use WikiJS.
We recommend creating and updating pages that adhere to one of the four forms of documentation we've decided to track.
Please limit creation of new pages to the tutorials, how-to, reference, or explanation folders depending on which documentation form your page should most resemble.
Writing Form | Folder Path |
---|---|
how-tos | /en/guide/ |
explanation | /en/explain/ |
reference | /en/reference/ |
tutorials | /en/tutorial/ |
Be sure to add any relevant keywords and tags to your documentation page. Examples: email, Roundcube, website, Wordpress, passwords
If you think the new page should be highlighted in one of our curated link pages please ask the TIAS documentation team for support.
May First subscribes to Language Justice principles and given the geographic distribution of our members we are fully committed to localizing all documentation pages to Mexican Spanish or more generally Latin American Spanish.
Our wiki software integrates a locale system but does not provide for automatic translation. To translate any page manually you can click on the globe icon in the upper right hand corner and create a new page in the appropriate language.
Wikijs saves pages to a git repository which we hope will lend itself to various translation workflows in the future. For example we could create scripts that interact with the repository to generate automatic translation of missing pages using the software API of a service like DeepL or preferably import our repository to platforms like Weblate to handle manual or semi-manual translation of pages, either by volunteers or by more experienced translators.