1. Mailing Lists
  2. Contributors
  3. The OCA Functional Working Group asks for your help!

Contributors mailing list archives

contributors@odoo-community.org

Browse archives

Github runners

server-tools pull request help

Avatar

The OCA Functional Working Group asks for your help!

by
NUMIGI Solutions Inc., Julie Lebrun
- 23/04/2024 19:28:54
Do you know of any tool that could easily allow to edit and create PRs of README files in GitHub without the need of having GitHub knowledge? Something similar to what Weblate does for .po files ?

Hello everybody!


During the last OCA Days, the OCA Functional Working Group (FWG) presented the work made on the Documentation Project.


This project was created by the FWG to help and attract functional people to contribute to modules documentation.


2 main options were analyzed


  • Using the existing Read Me file in the code so we have only one module documentation which regroups technical and functional information.

  • Using the GitHub Wiki on the repositories which could be really easy to put in place and use.


The decision was made to use the existing Read Me but to convert it into Markdown so it could be easier to use and to add images.


Following this decision, an issue was opened in GitHub about the use of the Wiki instead of Read Me : https://github.com/OCA/maintainer-tools/issues/606



BUT, we still have a big issue regarding this solution: the process to contribute to Read Me is really, really complicated for non-technicals.  


  1. You need to have a Github account and sign the OCA CLA

  2. You would have to fork the repository (well, here we already have lost most of the non-technical people).

  3. Then edit the files of the Read Me using the Web Editor (so you can add images).

  4. Download your images in the right folder than insert them into the file by Drag & Drop

  5. Create a commit and a PR.

  6. Finally, the changes would need to be approved by contributors who have those access rights.



So, we were thinking: if we add a Markdown tool that can be used to edit Read Me files and automatically push the changes into GitHub a little bit like the Weblate tool, we could combine the PROS of both options analyzed.



Does anyone have any idea of this kind of tool?


Thank you in advance for your help.



The OCA Functional Working Group

fwg@odoo-community.org



Follow-Ups