odoo/documentation#5476
Created by fw-bot
Statuses:
- ci/documentation: (runtime 63s)
- ci/codeowner_coverage: (runtime 10s)
- label
- odoo-dev:saas-16.1-14.0-l10n-poc-doc-restructure-for-co-zst-ROjH-fw
- head
- 0a671f19173fcd0666f9e763b59a5964ce9f1a90
- merged
- 2 years ago by Product Owners, Jonathan Castillo (jcs)
| odoo/documentation | |
|---|---|
| 14.0 | #3167 |
| 15.0 | #5466 |
| saas-15.2 | #5470 |
| 16.0 | #5472 |
| saas-16.1 | #5476 |
| saas-16.2 | #5477 |
| saas-16.3 | #5478 |
| saas-16.4 | #5479 |
| 17.0 | |
| 18.0 | |
| saas-18.2 | |
| saas-18.3 | |
| saas-18.4 | |
| 19.0 | |
| master | #5480 |
[FW][REF] l10n: PoC doc restructure for CO
Cherry pick of #2659, now pointing to the correct base branch.
>@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
└── colombia.rst
~~..........├── configuration~~
..........├── reports
..........├── workflows
~~..........├── configuration.rst~~
..........├── reports.rst
..........└── workflows.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.
>
> Each nested RST doc contains it's own media folder with the same name.
>
>The goal is to build a working model, and then replicate + keep this consistent structure throughout latam l1on docs.
EDIT: summarized doc structure, removed configuration doc/folder, merged content into colombia.rst per the ideal User Doc Structure guidelines.