From 80bea103e1d2589dbebbd203a93335003f2f2e4d Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Thu, 3 Feb 2022 11:50:36 -0300 Subject: [PATCH] Docs: reduce visibility of Config File V1 People is still arriving at Config File V1 and we want to avoid that as much as possible. However, we can't yet remove this documentation page since it's still working and there are people already using it. We should find a way to migrate these projects off from Config File V1 and finally remove this documentation page. However, that requires a much bigger amount of work. --- .readthedocs.yml | 2 +- docs/user/config-file/index.rst | 1 - docs/user/config-file/v1.rst | 4 +++- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index b2470dab4f5..725dbab9b54 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -19,7 +19,7 @@ search: ranking: # Deprecated content api/v1.html: -1 - config-file/v1.html: -1 + config-file/v1.html: -5 # Useful content, but not something we want most users finding changelog.html: -6 diff --git a/docs/user/config-file/index.rst b/docs/user/config-file/index.rst index 37004cc887a..a741eebb716 100644 --- a/docs/user/config-file/index.rst +++ b/docs/user/config-file/index.rst @@ -25,4 +25,3 @@ The main advantages of using a configuration file over the web interface are: :maxdepth: 3 Version 2 - Version 1 diff --git a/docs/user/config-file/v1.rst b/docs/user/config-file/v1.rst index 7aee9a5d1df..3818efac9d6 100644 --- a/docs/user/config-file/v1.rst +++ b/docs/user/config-file/v1.rst @@ -1,3 +1,5 @@ +:orphan: + Configuration File V1 (Deprecated) ================================== @@ -6,7 +8,7 @@ Read the Docs has support for configuring builds with a YAML file. .. warning:: - Version 1 shouldn't be used. + Version 1 is deprecated and shouldn't be used. The version 2 of the configuration file is now available. See the :ref:`new features ` and :ref:`how to migrate from v1 `.