Skip to content

Conversation

@nmarotte
Copy link
Contributor

@nmarotte nmarotte commented Nov 2, 2023

Overhauling of the documentation for Upgrade as part of the need for Partner documentation for upgrade (task 3171474 )

This keep most of the information intact, merging the FAQ into the documentation itself, improves the structure (one page), remove redundancies, ...

It is part of a 2-phases project where the second phase would be to add information about upgrade for developers (currently sitting in developer/reference/upgrade.rst but that will be moved to developer/howtos.html) to contain informations about migration scripts, upgrading custom code, etc ...

Related PR : #5774 #5953

@robodoo
Copy link
Collaborator

robodoo commented Nov 2, 2023

@nmarotte nmarotte force-pushed the 16.0-upgrade_doc_phase_1-3171474-nama branch 5 times, most recently from 4249a8d to 6a33cea Compare November 3, 2023 10:10
@nmarotte nmarotte marked this pull request as ready for review November 6, 2023 08:26
@C3POdoo C3POdoo requested review from a team November 6, 2023 08:28
@nmarotte nmarotte force-pushed the 16.0-upgrade_doc_phase_1-3171474-nama branch from 6a33cea to 287b6fa Compare November 6, 2023 09:21
@nmarotte
Copy link
Contributor Author

nmarotte commented Nov 6, 2023

Hello @xpl-odoo @AntoineVDV , this is the final PR for the first phase of the overhaul of the upgrade documentation.

@xpl-odoo Around 95% of the changes were already reviewed by you, and the rest of the changes can be viewed here (/!\ Only the administration/maintain/upgrade.rst is published, everything in developer/upgrade.rst is postponed, so no need to review it, as it is not part of this PR ) : https://github.com/odoo/documentation/pull/5953/files/89ad30ed5d3db3b5d9b3aebd7aca03e29e7d6a31..7233cb7a351d604345942331ec3d0264cad72cd4# (The SLA is simply copy pasted from what already existed before)

The other 5% are the various I changes I did on this PR, one to fix this
image

Another one to remove the note about "valid" subscriptions (https://github.com/odoo/documentation/pull/5953/files#diff-eb11d05d17bcc7b76a9453b1cdca38bc15380c0e3fbda7d6f2e68aa63f521dffR128)

and the last one to remove a trailing whitespace

Don't hesitate to let me know if you want to re-review this one last time together, or if it looks fine.

@AntoineVDV I'll be waiting for your explicit green light for merging this PR. If accepted before the OXP, I will merge it on Wednesday during the OXP, probably during the Keynote, if you think that is a good idea (I'd also like your feedback about when to publish it @augustoPerez and @odoo-pda , don't hesitate to let me know if you want it to be published at a specific time and date)

Thanks everyone for your help :)

Copy link
Contributor

@xpl-odoo xpl-odoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple of comments and minor spelling issues ;)

Copy link
Collaborator

@AntoineVDV AntoineVDV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Always happy to see the content tabs used in the doc! 🎉

LTGM from a tech POV, except for the redirect rules (see comment below).

If accepted before the OXP, I will merge it on Wednesday during the OXP, probably during the Keynote, if you think that is a good idea

I recommend you rather merge that ASAP today because you still need to forward-port it to 17.0, and I will create and merge the "publish 17.0" PR today, as the doc is built overnight. i.e., merge it the day before you want it published.

Also, is there a particular reason to merge this PR in 16.0 and not 15.0 (or even 14.0)? If not, you should create a new backport PR to put this current PR's content as-is in earlier versions so that the instructions are version-independent.

@robodoo delegate+

Comment on lines -15 to -18
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These pages should each be replaced by a redirect rule.

@nmarotte
Copy link
Contributor Author

nmarotte commented Nov 7, 2023

@AntoineVDV There is no particular reason for it to be pushed to 16.0 should I therefore retarget to 14.0 and pray for the least amount of conflict ? :D

I will work on the redirect now :D

@nmarotte nmarotte force-pushed the 16.0-upgrade_doc_phase_1-3171474-nama branch from 3d73c9d to 3028123 Compare November 7, 2023 10:13
@C3POdoo C3POdoo requested a review from a team November 7, 2023 10:13
@nmarotte nmarotte force-pushed the 16.0-upgrade_doc_phase_1-3171474-nama branch from c7b5bc0 to a5e847f Compare November 7, 2023 10:26
@nmarotte
Copy link
Contributor Author

nmarotte commented Nov 7, 2023

robodoo r+

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants