LibreTranslate options are not clearly documented

Open Beginner friendly
#1,893 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
85/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Domain
documentation

Research direction

Start in content/en/admin/config.md around the LibreTranslate configuration at the linked lines. Update the documentation to state that LIBRE_TRANSLATE_API_KEY is optional and show an example LIBRE_TRANSLATE_ENDPOINT without the /translate path; done means both options are accurately explained.

Written by the indexing model from the issue text.

Description

In the docs it says

LibreTranslate needs LIBRE_TRANSLATE_API_KEY and LIBRE_TRANSLATE_ENDPOINT

Source

This should be improved in several ways:

  1. LIBRE_TRANSLATE_API_KEY is in fact not required. LibreTranslate can be run without API keys. In fact, the devcontainer setup of mastodon/mastodon gives an example for this.
  2. There should be an example for LIBRE_TRANSLATE_ENDPOINT to illustrate whether the /translate path should be included or not (it shouldn't).
Dominant language
SCSS
Stars
1.7k
Forks
978
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from mastodon/documentation

All issues in mastodon/documentation

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.