documentation
documentation copied to clipboard
[REF] l10n: CO new doc structure
Task: #4720
@StraubCreative and @samueljlieber found the latam l10n docs could use an update/cleanup to break apart the single long-form article for each l10n module.
This PR was created as a proof of concept to improve the structure of latam l10n docs so they are more consumable and follow a similar flow to the rest of the documentation. The proposed document structure is for Colombia only in this PR, although this structure applies to all latam l10n countries.
The details of the proposed document structure can be found here, the structure is summarized below:
localizations
└── colombia.rst
├── configuration.rst
├── workflows.rst
└── reports.rst
colombia.rst is the main l10n doc providing an introduction, video tutorials, scope, and glossary of terms.
|_ configuration.rst outlines the steps to install the localization module and the basic configuration setup.
|_ workflows.rst outlines the main workflows of the module, common problems/errors, and more advanced workflows.
|_ reports.rst outlines the financial reporting process of the module.
The goal is to keep this consistent structure throughout latam l1on docs.
Hello all :) @samueljlieber and @StraubCreative
Sorry I didn't answer earlier about the localization pages. I still haven't read this PR, but may I ask you to use a list table like in the Egyptian localization, for example, for the modules to install? Thanks
Have a good day :)
Hi @jcs-odoo 👋 I added the module list table for Colombia following the format of the Egyptian localization document, thank you for this suggestion! 🙂
Putting back into draft as there are sections that need attention before review.
ToDos to address before we can entertain a review/merge here:
- rename all images so they follow convention
- resize/compress images as needed; take new screenshots as needed
- add missing expository content for all "lean" sections, or sections that rely too much on images (@samueljlieber we can work with @vbe-odoo on that, same thing we're doing for AR doc)
- revise/remove sections w/ placeholder text (e.g.
colombia.rst-->Scope+Glossary) - add
:toctree:on-page menu tocolombia.rst - Add
:seealso:sections w/ appropriate links to bottom of each new CO documentation page - double check + rewrite all hyperlinks so they a) work and b) are more contextual
- remove all instances of title case in headings...maybe add more context to indicate that they're CO specific?
- fully review all body copy and improve where necessary (like AR doc)
- standard content + RST guidelines checks
@samueljlieber since there doesn't appear to be issue with nested content PoC, so let's reconnect on the rest so we can really polish this up before we pass off to accounting-review team :)
Changes made in 497206d:
- renamed all images to follow convention & compressed images
- removed unnecessary images in sections and added textual context (
colombia07.png,colombia11.png,colombia12.png,colombia14.png, &colombia18.png) - removed placeholder text from documents, left the
Scope&Glossaryheadings incolombia.rst(needs content) - added
:toctree:on-page menu tocolombia.rst - added
.. seealso::section with references to the other CO L10n docs at the bottom of each CO doc - checked all hyperlinks work and added context where I could
- updated headings to use sentence case
- reworded some headings for better context
- improved body copy where I could for grammar and flow
- added
:guilabel:tags for all applicable elements
CC @StraubCreative
This PR is pointing to the wrong base branch. Continuing updates over on #3167