-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MLPAB-1735 - add instructions for configuring weblate cli (#952)
* add instructions for configuring weblate
- Loading branch information
1 parent
9a0289c
commit 064cc3b
Showing
2 changed files
with
46 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
; see docs/runbooks/configuring_weblate_access.md | ||
[weblate] | ||
translation = opg-modernising-lpa/opg-modernising-lpa |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# Configuring weblate access to manage translations and merge conflicts | ||
|
||
These are instructions for configuring weblate access | ||
|
||
## Prerequisites | ||
|
||
install the weblate cli | ||
|
||
```sh | ||
pip install wlc | ||
``` | ||
|
||
there are instructions also for using the docker image here: `https://docs.weblate.org/en/weblate-5.2.1/wlc.html#docker-usage` | ||
|
||
## Configuring weblate access | ||
|
||
Put the following in your `~/.config/weblate` file: | ||
|
||
```ini | ||
[weblate] | ||
url = https://moj.weblate.cloud/api/ | ||
|
||
[keys] | ||
https://moj.weblate.cloud/api/ = APIKEY | ||
``` | ||
|
||
Your api key can be found in the weblate account page under `https://moj.weblate.cloud/accounts/profile/#api` | ||
|
||
## Managing translations | ||
|
||
The repository has a `.weblate` file which contains the configuration for our translations. | ||
|
||
That means from the repository root you can run weblate cli commands like: | ||
|
||
```sh | ||
wlc ls | ||
``` | ||
|
||
or | ||
|
||
```sh | ||
wlc lock | ||
``` |