Skip to Content
  2. Mailing Lists
  3. Contributors
  4. Re: "The plan" to help non technical to contribute documentation on OCA modules

Archives

Contributors

Re: "The plan" to help non technical to contribute documentation on OCA modules

Re: "The plan" to help non technical to contribute documentation on OCA modules

Re: "The plan" to help non technical to contribute documentation on OCA modules


On Thu, Dec 19, 2024 at 2:16 AM Adam Heinz <notifications@odoo-community.org> wrote:
We've attempted to go this route ourselves, but have struggled to make our less technical users self-sufficient in tour creation. Is recording tours a new feature of a recent version of Odoo?

On Wed, Dec 18, 2024 at 6:13 AM Graeme Gellatly <notifications@odoo-community.org> wrote:
For me the fastest way to document most OCA modules AND have them apply across versions AND have them always current is to use tours which can now simply be recorded, exported, played and could apply per version, I am asking my team to do that for everything now. It not only has the benefit of allowing the user a guided how to of how to use the module, but it also becomes a test across versions and actually makes reviewing PR's easier. IOW, your documentation (tour in this case) becomes part of your test suite. Your test suite becomes part of documentation. Because every version would have its own tour, then you just need to click the version in whatever service/website. You can link whatever version to runboat to try the tour.

_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe

by Graeme Gellatly - 09:11 - 18 Dec 2024

Reference

  • "The plan" to help non technical to contribute documentation on OCA modules
    Hello,

    This is a followup email for this email thread:

    During the 2024 OCA Days, the OCA Consultants working group presented the status of the Documentation project: how to document OCA modules right now (using the Github workflow) with Julie and Florencia (video here: https://youtu.be/Kw0V_PdBUPg?feature=shared).

    In parallel, a prototype of a new tool and process to easily document OCA modules has been proposed by Jairo Llopis, after discussion with Stéphane Bidoul to take into account the full picture of OCA infrastructure.

    The goal of this new way of managing the documentation is two-fold:
    1. Allow consultants to update the documentation in a user-friendly tool
    2. Have a beautiful website with a good search features to find and read the OCA modules documentation

    This will impact the way the documentation is managed in the OCA modules. In summary, the documentation of all the OCA modules will be visible on a dedicated website, that will in the end of the transition replace the current OCA App Store. The documentation itself will be stored in a dedicated Doc repository (https://github.com/OCA/docs) and be removed from the readmes of the modules (where a link to the dedicated website will be displayed). Finally, there will be only one documentation page for all the versions of one module.

    The next steps are gathered in an issue on Github, called "the plan". Here it is:

    To get more information about this, please check the link above. You can also read the latest meeting notes of the Consultants meeting held in November here: https://docs.google.com/document/d/1v23TwOwm9I7w3MNFZo-iCWQxVKedwoVzN9nEyflJVd8/edit?usp=sharing

    If you want to share your feedback on this topic, I propose to keep it in the related issue on Github:

    Thanks a lot to the consultants working group and especially to Jairo and Stéphane for their help! As you'll see in the plan, there are many "todo"s and help is always welcome.

    All the best,
    Virginie Dewulf
    Executive Director
    +32 477 64 17 20
    by Virginie Dewulf - 02:26 - 10 Dec 2024