Skip to content

Commit

Permalink
Docs: reduce visibility of Config File V1
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
humitos committed Feb 3, 2022
1 parent 3d4d3cb commit 07086a9
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 0 additions & 1 deletion docs/user/config-file/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,3 @@ The main advantages of using a configuration file over the web interface are:
:maxdepth: 3

Version 2 <v2>
Version 1 <v1>
2 changes: 1 addition & 1 deletion docs/user/config-file/v1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,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 <config-file/v2:New settings>`
and :ref:`how to migrate from v1 <config-file/v2:Migrating from v1>`.
Expand Down

0 comments on commit 07086a9

Please sign in to comment.