[FIX] technical: clarify instructions for redirect rules

This commit is contained in:
Antoine Vandevenne (anv) 2020-04-07 09:29:32 +02:00 committed by Antoine Vandevenne (anv)
parent 09bab807aa
commit 72f93038b5

View File

@ -11,29 +11,17 @@
# A redirect rule must be added to this file in the following cases:
#
# 1. An RST file is moved from one location to another.
# Example: The TOC of the Sales app is moved into a file index.rst located in sales/ .
# Rule: sales.rst sales/index.rst
# Example: The documentation of the Sales app is moved from sale_app/ to sales/ .
# Rules: sale_app/send_quotations.rst sales/send_quotations.rst
# sale_app/send_quotations/quote_template.rst sales/send_quotations/quote_template.rst
# sale_app/invoicing.rst sales/invoicing.rst # ...and so on.
#
# 2. An RST file is renamed.
# Example: The file create_quotations.rst in sales/ is renamed to quotations.rst.
# Rule: sales/create_quotations.rst sales/quotations.rst # no longer limited to creating quotes
#
# 3. Another pertinent case.
# Example: The file open_order_line_popup.rst is removed from sales/ in 13.0.
# Rule (13.0 only): sales/open_order_line_popup.rst sales/orders.rst # feature replaced in 13.0
#
# Note that if the old file was already present in previous versions, the rule needs to be added
# from the branch of the lowest of those versions (usually 11.0) to allow the version switcher to
# land on the correct page (the redirection will be duplicated in other branches).
# Redirections taking effect as of 11.0 :
# Redirections taking effect as of 12.0 :
# Redirections taking effect as of 13.0 :
# Write your rules in the section below corresponding to your target version. All rules are active
# no matter the version. The section's only purpose is to help with the triage.
# Consider indicating the reference of the PR (#123) that made a rule necessary, if any.
# Redirections introduced in 11.0 :