|
| 1 | +.. post:: November 28, 2023 |
| 2 | + :tags: docs, versions |
| 3 | + :category: Changelog |
| 4 | + :author: Santos |
| 5 | + :location: CUE |
| 6 | + |
| 7 | +Introducing support for version-only projects |
| 8 | +============================================= |
| 9 | + |
| 10 | +URLs are an important part of your documentation. |
| 11 | +Users can infer from the URL if your documentation has or supports |
| 12 | +multiple versions or translations. |
| 13 | + |
| 14 | +Until now, Read the Docs allowed you to configure your project in two ways: |
| 15 | + |
| 16 | +Multiple versions with translations |
| 17 | + Resulting in URLs like: |
| 18 | + |
| 19 | + - ``/en/latest/index.html`` |
| 20 | + - ``/es/latest/index.html`` |
| 21 | + - ``/en/1.0/index.html`` |
| 22 | + |
| 23 | +Single version without translations |
| 24 | + Resulting in URLs like: |
| 25 | + |
| 26 | + - ``/index.html`` |
| 27 | + - ``/api/v3.html`` |
| 28 | + |
| 29 | +While not all projects have or require translations, many benefit from having multiple versions. |
| 30 | +This meant that projects without translations but with need for multiple versions, |
| 31 | +had to opt into supporting translations in order to have multiple versions. |
| 32 | + |
| 33 | +**We're excited to announce that we now support projects with multiple versions without translations.** |
| 34 | +Resulting in URLs like: |
| 35 | + |
| 36 | +- ``/latest/index.html`` |
| 37 | +- ``/1.0/index.html`` |
| 38 | + |
| 39 | +Now instead of having a ``Single version`` checkbox in the ``Admin`` page of your project, |
| 40 | +you'll see a ``Versioning scheme`` dropdown with three options available. |
| 41 | + |
| 42 | +Changes in the API |
| 43 | +------------------ |
| 44 | + |
| 45 | +In order to support this new feature, we have made some changes to the API. |
| 46 | +Specifically, the ``single_version`` field has been deprecated in favor of the ``versioning_scheme`` field. |
| 47 | + |
| 48 | +When updating a project, you should use the ``versioning_scheme`` field instead of the ``single_version`` field. |
| 49 | +To avoid breaking existing integrations, |
| 50 | +the ``single_version`` field will still be returned in the API, |
| 51 | +but you should use the ``versioning_scheme`` field instead. |
0 commit comments