Skip to content

Commit 0639f23

Browse files
committed
docs: clarify wlc changed behavior
Describe migration path in more detail. See WeblateOrg/wlc#1122
1 parent 04f8692 commit 0639f23

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

docs/wlc.rst

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,33 @@ You can then invoke commands on the default server:
8989

9090
:ref:`wlc-config`
9191

92+
.. _wlc_legacy:
93+
94+
Legacy configuration
95+
++++++++++++++++++++
96+
97+
.. versionchanged:: 1.17
98+
99+
The legacy configuration using unscoped ``key`` is no longer supported.
100+
101+
Migrate legacy configuration:
102+
103+
.. code-block:: ini
104+
105+
[weblate]
106+
url = https://hosted.weblate.org/api
107+
key = YOUR_KEY_HERE
108+
109+
To a configuration with key scoped to an API URL:
110+
111+
.. code-block:: ini
112+
113+
[weblate]
114+
url = https://hosted.weblate.org/api
115+
116+
[keys]
117+
https://hosted.weblate.org/api = YOUR_KEY_HERE
118+
92119
Synopsis
93120
++++++++
94121

@@ -287,7 +314,7 @@ customize this by :option:`--config-section`):
287314

288315
.. versionremoved:: 1.17
289316

290-
Use the ``[keys]`` section to specify keys scoped for individual API URLs.
317+
Use the ``[keys]`` section to specify keys scoped for individual API URLs, see :ref:`wlc_legacy`.
291318

292319
.. describe:: url
293320

0 commit comments

Comments
 (0)