14.0 imp documentation

[legalsylvain]

First commit : Fix missing fetch

• trivial patch to fetch the file https://github.com/OCA/OpenUpgrade/raw/13.0/odoo/openupgrade/doc/source/modules120-130.rst that was missing.

Second commit : Improve coverage visibility

• consider that the coverage of the current version (modules130-140.rst) is now in the ROADMAP.rst file of the openupgrade_scripts module. With that change, the coverage will be present on app stores, on pypi, and in the readme of the openupgrade_scripts on github. I think that it is an important information that should be very visible (a lot of issues are opened because users doesn't know the coverage of the current version)
• add another line in the fetch_coverage.sh file to get the file modules130-140.rst up to date.
• add a DEVELOP.rst section to explicit what to write in the ROADMAP.rst file. (possible values)

Hope you'll see that changes as relevant.

kind regards.

CC : @pedrobaeza, @StefanRijnhart

--
I confirm I have signed the CLA and read the PR guidelines at www.odoo.com/submit-pr

[pedrobaeza]

This section is not maintained at all, so better to remove it, and link with current discussion at #2661

[legalsylvain]

Hi @pedrobaeza.

• I just copied the file, not changed the content.
• AFAIK, this part is for Odoo features that moved in OCA modules (or the inverse). See, for the V12 coverage file : https://doc.therp.nl/openupgrade/modules110-120.html#oca-modules

[pedrobaeza]

Yes, that's why I'm saying to remove it from both parts.

[StefanRijnhart]

There is already https://github.com/OCA/OpenUpgrade/blob/14.0/doc/source/modules130-140.rst. I don't find moving it here very intuitively. In the roadmap, we can link to this doc instead.

[legalsylvain]

There is already https://github.com/OCA/OpenUpgrade/blob/14.0/doc/source/modules130-140.rst.

the idea is to have the master file in the readme folder of the script module. and then to have it also up to date in the documentation, because of the wget here as all the other coverage files (of the other revision)

So, finally

• /doc/ is for all the general documentation, which should not move much
• openupgrade_scripts is for all the scripts, and i consider this coverage file as the roadmap of this module, so when we propose a script, we change only files of a single folder.

In the roadmap, we can link to this doc instead.

Indeed, if you don't like this move, we can just consider to add a link to the coverage section. It's better than nothing.

[MiquelRForgeFlow]

I vote for the link option. It's not good to maintain duplicated .rst files.

[legalsylvain]

Hi all, do you know when (and where)

• doc/fetch_coverage.sh is executed ? I don't understand very well how all the coverage files are updated, specially files of other revisions

• how the website is configured ? the current coverage page https://doc.therp.nl/openupgrade/status.html seems to point on very obsolete page

• not on the V14 page

• not on the V13 page

• but on a altered version of V12 page

[StefanRijnhart]

Those two issues are related. Hosting the documentation there is a legacy issue from the time that OpenUpgrade itself was hosted on the Therp GitHub account. Now that @hbrunn has left Therp as well, it is not being updated anymore and we should host it under the OCA umbrella. When we set that up, we can configure a build job to fetch the coverage files and push the documentation.

[pedrobaeza]

Any news on this, Sylvain?

[MiquelRForgeFlow]

Sylvain, note that we have added a functional documentation github workflow in #2744.

[legalsylvain]

Well we should before fix what Stefan said. The website is not updated since years, that is a pity. Don't know exactly how to move forward, though. New website named doc-openupgrade.odoo-community.org ?

[StefanRijnhart]

Maybe we should commit the HTML in a Github job to the <latest> branch and host it with Github pages. It will then be available at https://OCA.github.io/OpenUpgrade if I understand correctly.

[pedrobaeza]

I vote for moving to GitHub pages. Any of you have experience doing that?

[StefanRijnhart]

No, but I can try.

[pedrobaeza]

That would be awesome

[StefanRijnhart]

See #2765. But I need to look into the gitbot thing.

[tmotyl]

Hi
I see that docs are now rendered fine using github pages.

What are the next steps with this patch? I wanted to push some fixes to docs I found when reading, but first maybe its better to merge outstanding patches related to documentation so I dont have to fix sth which is already fixed.

[StefanRijnhart]

I believe the main objective of this PR was to increase the exposure of the module coverage. Given the discussion above about how to do so, and the subsequent implementation of live documentation, I think this PR can be closed.