| Message ID | 20230213180718.2918214-1-i.maximets@ovn.org |
|---|---|
| State | Accepted |
| Headers | show |
| Series | [ovs-dev] Documentation: Fix the LTS link in ovn-upgrades doc. | expand |
| Context | Check | Description |
|---|---|---|
| ovsrobot/apply-robot | success | apply and check: success |
| ovsrobot/github-robot-_Build_and_Test | fail | github build: failed |
| ovsrobot/github-robot-_ovn-kubernetes | fail | github build: failed |
On 2/13/23 19:07, Ilya Maximets wrote: > Even though it somehow works, we're not supposed to link sections > of other documents directly via html page. For example, this will > not work if someone will decide to build a PDF version of the docs. > > Use a reference to a tagged section instead. > > Fixes: e7ed121ee0f8 ("docs: Extend upgrade documentation.") > Signed-off-by: Ilya Maximets <i.maximets@ovn.org> > --- Thanks, Ilya! I applied this to the main branch. Regards, Dumitru
diff --git a/Documentation/internals/release-process.rst b/Documentation/internals/release-process.rst index 6aeb7f3c9..848c2db84 100644 --- a/Documentation/internals/release-process.rst +++ b/Documentation/internals/release-process.rst @@ -75,6 +75,8 @@ Scheduling`_ for the timing of each stage: 2019.10.2, and so on. The process is the same for these additional release as for a .0 release. +.. _long-term-support: + Long-term Support Releases -------------------------- diff --git a/Documentation/intro/install/ovn-upgrades.rst b/Documentation/intro/install/ovn-upgrades.rst index f2978541c..bb387e2f8 100644 --- a/Documentation/intro/install/ovn-upgrades.rst +++ b/Documentation/intro/install/ovn-upgrades.rst @@ -65,7 +65,7 @@ needs to understand the structure of the database for the version you are upgrading from and to simultaneously. To avoid buildup of complexity and technical debt we limit the span of versions -supported for a rolling upgrade on `Long-term Support Releases`_ (LTS), and it +supported for a rolling upgrade on :ref:`long-term-support` (LTS), and it should always be possible to upgrade from the previous LTS version to the next. The first LTS version of OVN was 22.03. If you want to upgrade between other @@ -203,8 +203,6 @@ you should be able to safely complete an OVN upgrade before upgrading any integration in use. .. LINKS -.. _Long-term Support Releases: - ../../internals/release-process.html#long-term-support-releases .. _ovn-controller man page: https://www.ovn.org/support/dist-docs/ovn-controller.8.html .. _version pinning check in the incremental processing engine:
Even though it somehow works, we're not supposed to link sections of other documents directly via html page. For example, this will not work if someone will decide to build a PDF version of the docs. Use a reference to a tagged section instead. Fixes: e7ed121ee0f8 ("docs: Extend upgrade documentation.") Signed-off-by: Ilya Maximets <i.maximets@ovn.org> --- Documentation/internals/release-process.rst | 2 ++ Documentation/intro/install/ovn-upgrades.rst | 4 +--- 2 files changed, 3 insertions(+), 3 deletions(-)