doc: Update translation process guide #29414

pablomartin4btc commented at 12:32 AM on February 9, 2024: member

Updating Transifex broken link and setup Transifex config file with a token.

DrahtBot commented at 12:32 AM on February 9, 2024: contributor

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Code Coverage

For detailed information about the code coverage, see the test coverage report.

Reviews

See the guideline for information on the review process.

Type	Reviewers
ACK	hebasto, hernanmarino
Stale ACK	epiccurious

If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

DrahtBot added the label Docs on Feb 9, 2024

in doc/translation_process.md:49 in 1556026e24 outdated

  43 | @@ -44,11 +44,11 @@ Visit the [Transifex Signup](https://www.transifex.com/signup/) page to create a
  44 |  You can find the Bitcoin translation project at [https://www.transifex.com/bitcoin/bitcoin/](https://www.transifex.com/bitcoin/bitcoin/).
  45 |  
  46 |  ### Installing the Transifex client command-line tool
  47 | -The client is used to fetch updated translations. If you are having problems, or need more details, see [https://docs.transifex.com/client/installing-the-client](https://docs.transifex.com/client/installing-the-client)
  48 | +The client is used to fetch updated translations. If you are having problems, or need more details, see https://developers.transifex.com/docs/cli.
  49 |  
  50 | -`pip install transifex-client`
  51 | +`curl -o- https://raw.githubusercontent.com/transifex/cli/master/install.sh | bash` (Installing latest varsion with Linux/Mac)

maflcko commented at 8:23 AM on February 9, 2024:

Instead of copy-pasting third-party docs, it may be better to just update the link to the third-party docs and remove the outdated parts, to reduce the maintenance overhead here.

hebasto commented at 10:41 AM on February 9, 2024:

I agree. The part regarding to the ~/.transifexrc file is outdated as well and might be dropped. This file is generated automatically after providing a token during the first run:

API token not found. Please provide it and it will be saved in '~/.transifexrc'.
If you don't have an API token, you can generate one in https://app.transifex.com/user/settings/api/
>

The autogenerated ~/.transifexrc file looks like that:

$ cat ~/.transifexrc
[https://app.transifex.com]
rest_hostname = https://rest.api.transifex.com
token         = [REDACTED]

pablomartin4btc commented at 6:23 PM on February 9, 2024:

I'd leave the ~/.transifexrc in case the user creates an account in Transifex directly, instead of using another platform account like GitHub.

pablomartin4btc commented at 9:53 PM on February 14, 2024:

I've reconsidered @hebasto suggestion and will drop the ~/.transifexrc section.

pablomartin4btc force-pushed on Feb 9, 2024

in doc/translation_process.md:49 in 6aae096b7d outdated

  43 | @@ -44,11 +44,9 @@ Visit the [Transifex Signup](https://www.transifex.com/signup/) page to create a
  44 |  You can find the Bitcoin translation project at [https://www.transifex.com/bitcoin/bitcoin/](https://www.transifex.com/bitcoin/bitcoin/).
  45 |  
  46 |  ### Installing the Transifex client command-line tool
  47 | -The client is used to fetch updated translations. If you are having problems, or need more details, see [https://docs.transifex.com/client/installing-the-client](https://docs.transifex.com/client/installing-the-client)
  48 | +The client is used to fetch updated translations. If you are having problems, or need more details, see https://developers.transifex.com/docs/cli.
  49 |  
  50 | -`pip install transifex-client`

epiccurious commented at 3:08 AM on February 11, 2024:

Why remove this?

hebasto commented at 10:10 AM on February 14, 2024:

Because it is outdated.

pablomartin4btc commented at 2:45 PM on February 14, 2024:

When you run it, it will install an old version which doesn't work.

pip install transifex-client
Defaulting to user installation because normal site-packages is not writeable
Collecting transifex-client
  Downloading transifex-client-0.12.5.tar.gz (181 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 181.5/181.5 KB 199.8 kB/s eta 0:00:00
  Preparing metadata (setup.py) ... done
Requirement already satisfied: six in /usr/lib/python3/dist-packages (from transifex-client) (1.16.0)
Requirement already satisfied: urllib3 in /usr/lib/python3/dist-packages (from transifex-client) (1.26.5)
Building wheels for collected packages: transifex-client
  Building wheel for transifex-client (setup.py) ... done
  Created wheel for transifex-client: filename=transifex_client-0.12.5-py3-none-any.whl size=177144 sha256=faf2625c91af641d91e0baabc2ae6d1e5c4688efddcab63718af48a676211224
  Stored in directory: /home/pablo/.cache/pip/wheels/42/75/e2/0bd16100cf22a1a4ece20fedde2db19634b6a9625f079386ce
Successfully built transifex-client
Installing collected packages: transifex-client
Successfully installed transifex-client-0.12.5


python3 ../bitcoin-maintainer-tools/update-translations.py
Usage: tx [tx_options] pull [options]

tx: error: no such option: --translations
Error while fetching translations

in doc/translation_process.md:49 in 6aae096b7d outdated

  48 | +The client is used to fetch updated translations. If you are having problems, or need more details, see https://developers.transifex.com/docs/cli.
  49 |  
  50 | -`pip install transifex-client`
  51 | -
  52 | -Setup your Transifex client config as follows. Please *ignore the token field*.
  53 | +Setup your Transifex client config as follows. Please *ignore the token field* (unless you signed up associating your GitHub account, or another network account offered optionally by Transifex, which in that case the config file will be updated automatically with the provided token by the user once you execute the below mentioned script `update-translations.py` and a link to generate the token will be given).

epiccurious commented at 3:10 AM on February 11, 2024:

Nit (feel free to disregard) - this is a run-on sentence and complicated to follow. Please break it up to be more readable.

pablomartin4btc commented at 9:55 PM on February 13, 2024:

True, I'll re-phrase it, thank you!

pablomartin4btc commented at 9:50 PM on February 14, 2024:

I'll remove it entirely as it was also pointed out by @hebasto.

epiccurious commented at 3:11 AM on February 11, 2024: contributor

utACK 6aae096b7d525e02f54b66b6eb1b4520ae4a7f0c.

epiccurious approved

in doc/translation_process.md:47 in 6aae096b7d outdated

  43 | @@ -44,11 +44,9 @@ Visit the [Transifex Signup](https://www.transifex.com/signup/) page to create a
  44 |  You can find the Bitcoin translation project at [https://www.transifex.com/bitcoin/bitcoin/](https://www.transifex.com/bitcoin/bitcoin/).
  45 |  
  46 |  ### Installing the Transifex client command-line tool
  47 | -The client is used to fetch updated translations. If you are having problems, or need more details, see [https://docs.transifex.com/client/installing-the-client](https://docs.transifex.com/client/installing-the-client)
  48 | +The client is used to fetch updated translations. If you are having problems, or need more details, see https://developers.transifex.com/docs/cli.

hebasto commented at 4:59 PM on February 13, 2024:

I think the second sentence should be reworked to refer to https://developers.transifex.com/docs/cli unconditionally, because our docs do not provide install instructions any more.

pablomartin4btc commented at 9:56 PM on February 13, 2024:

Agreed.

pablomartin4btc force-pushed on Feb 14, 2024

pablomartin4btc commented at 10:06 PM on February 14, 2024: member

I've addressed feedback from reviewers, thanks to all!

doc: Update translation_process.md

Updating Transifex broken link and remove Transifex config file
section as it has been outdated.

3b0ec06d62

hebasto approved

hebasto commented at 10:18 AM on February 15, 2024: member

ACK 3b0ec06d6228d965e9cf9121c5dd300da2a930ea.

DrahtBot requested review from epiccurious on Feb 15, 2024

hernanmarino approved

hernanmarino commented at 9:31 PM on February 15, 2024: contributor

ACK 3b0ec06d6228d965e9cf9121c5dd300da2a930ea It might be interesting to add to this guide the details expressed in this comment https://github.com/bitcoin-core/gui/pull/793#issuecomment-1943421925

DrahtBot removed review request from epiccurious on Feb 15, 2024

DrahtBot requested review from epiccurious on Feb 15, 2024

fanquake merged this on Feb 16, 2024

fanquake closed this on Feb 16, 2024

bitcoin locked this on Feb 15, 2025