pytest-dev / pytest-dev/pytest

Support docs in multiple languages

Open
#6,922 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: docs type: proposal
Dominant language
Python
Stars
14.5k
Forks
3.4k
Avg merge
2d 9h
Merged PRs (30d)
35

Description

I know we had the docs translated to Japanese in the past and, although the initial work seems to have been good, it did not work out because the Japanese docs quickly got out of date with the English docs, and we eventually dropped it.

https://github.com/pytest-dev/pytest/issues/6900#issuecomment-598727326 made me think if we should perhaps pursue this again, but this time using a framework/overflow where the translated docs would happen outside/independently of pytest's own repository. I'm sure there are tools to help it out as well (didn't take the time to really look for it though).

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.

Research direction

Start with the discussion linked from issue 6900, especially comment 598727326, and review this issue's prior comments for the translation approach that was considered. Research frameworks or workflows that keep translated documentation outside pytest's repository and prevent it from drifting out of date. Done would be an agreed, maintainable approach rather than a specific file change.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.