Onion MkDocs tryout

About the project

• Contact: @rhatto
• Chat: #tor-dev on irc.oftc.net
• Video room: to be defined.

Participants

• @rhatto
• @gus
• etc

Summary

This is a proposal to try Onion MkDocs for documenting things at Tor.

Project A - Support

• Provide support for people/teams that want to convert their wikis to or have docs for their projects using Onion MkDocs.
• Improve Onion MkDocs stylesheet, plugins etc.
• Improve Onion MkDocs documentation.

Project B - Convert

• Convert some GitLab wikis to GitLab pages using Onion MkDocs:
  • Overview: tpo/tpa/team#41119 (comment 2898441)
  • Candidates for merge requests:
    • The Hackweek project itself: https://gitlab.torproject.org/tpo/community/hackweek, with site now available at https://tpo.pages.torproject.net/community/hackweek/
    • Onion Support Wiki: https://gitlab.torproject.org/tpo/onion-services/onion-support/. To be done on Project C below.
    • Tor Policies repository: policies#3 (closed)

Project C - Investigate

• Investigate how Onion MkDocs could be a TPA-RFC-38 wiki replacement (#40909) · TPA / TPA team (tpa rfc 38 new wiki service):
  • One approach would be to create a script that import content from some existing GitLab wikis into a single Onion MkDocs instance, to see how it would like to have a convergent "documentation integration" place. How it could be structured? Could it be easily searchable? What would be the best practices for this?

Skills

Some knowledge in the following technologies may be needed in order to participate:

• Git/GitLab.
• Markdown.
• Basic scripting (Python, shell).

Links