This post aims to be the main page for writers that want to apply for the Google Season of Docs 2020 program.
- We use restructured text and Sphinx for writing documentation
- Our documentation is always included on our source code repositories, so we expect you to be familiar with our development process.
- We do code review and we also do it for documentation. So we expect you to upload a proposal of your documentation and our mentors will review your patches and suggest improvements.
For the 2020 season of docs we have the following mentors:
- Sergi Almacellas Abellana from Spain (@pokoli on this forum).
- Korbinian Preisler from Germany (@timitos on this forum).
Feel free to send a DM to both of us to ask anything that may not be clear. We will try to answer as soon as possible but as we are both based in Europe and we are both humans. So do not expect us to answer while we are sleeping
Ideas to work on
1. Introduction to end user documentation
We agreed that the documentation needs a rewrite on it’s structure. As an ERP and a development framework we have three different audiences:
- End users
- System Administrators
We need to have a main page where we explain to the different users how they can find the resources they are interested in. This includes organizing some parts of our documentation and providing links to each relevant section.
2. End user documentation for basic modules
After some discussions we agreed on how we want to structure our documentation for end users.. Work has started to document some basic modules but we need more doing to have a proper documentation for common modules.
If you pick this task you will be responsible for documenting how an end user can use our modules to manage accounting, sales, purchases, production and other functionality provided by our system.
3. Adding tool-tips on the application
Our application has the ability to show tool-tips to the users that explain the usage of an specific field. We’ve started documenting some modules but we did not succeed in complete them.
If you pick this task you will be responsible for adding tool-tips for modules that are missing them.
4. Docker deployment tutorial
There are a lot of options to deploy Tryton (using distribution packages, using docker images, from sources, from pypi, etc). This means that normally everyone has their own way of deploying it.
We would like to have a part of our documentation that explains how to deploy Tryton for production.
There is a video of deploying tryton with docker, but we are missing it as part of our documentation. If you pick this idea, we will expect that you create this documentation.
5. Developer Tutorial
There is a work in progress developer tutorial but it’s work was abandoned and we would like to rescue it, update it and include it as part of our documentation.
There are also some third party tutorials that cover more topics. It would be great to also merge resources from these tutorials to have a single and official developer tutorial.