documentation/redirects/11.0.txt

4 lines
138 B
Plaintext
Raw Permalink Normal View History

[IMP] redirects: split redirects.txt into multiple, per-version, files The `redirects.txt` file used to specify redirect rules for renamed or moved documentation pages is starting to grow too big to be easily maintainable. The main reason is that the number of redirect rules that were thought to be required has been largely underestimated when implementing the 'redirects' extension. At first, we believed that no guidelines or structure were necessary because only a small amount of redirect rules would be specified. This proved wrong and the file is now becoming a mess, making it increasingly difficult to figure out where, why, when, and if a redirect rule is specified in the file. As the file is versioned, another issue emerges: conflicts occur every time a commit is forward-ported to a later version if that commit adds a redirect rule at the end of the file or at a line that was changed in the later version. As redirect rules are frequently added, and since blocks of redirect rules for new versions are added at the end of the file, this tends to happen a lot. This commit attempts to hit two birds with one stone by splitting the `redirects.txt` file into multiple files, one per version. While doing so, the existing redirect rules are ordered alphabetically and moved into contextual blocks. Instructions and guidelines on how to create redirect rules are also listed in the `redirects/MANUAL.md` file. By sorting the redirect rules and adding them in different files, the number of conflicts should decrease by a lot. task-2891912 closes odoo/documentation#2292 X-original-commit: 0417b955142331c16d82e0f4bafe5609f8b39da0 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-22 19:07:05 +07:00
# contributing/
contributing/documentation/guidelines.rst contributing/documentation/rst_guidelines.rst # guidelines --> rst_guidelines