Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add mechanism for adding doc translations #18

Open
RusinovAnton opened this issue Nov 12, 2019 · 1 comment
Open

Add mechanism for adding doc translations #18

RusinovAnton opened this issue Nov 12, 2019 · 1 comment

Comments

@RusinovAnton
Copy link
Member

RusinovAnton commented Nov 12, 2019

The draft spec on the translation mechanism:

  • each docs translation should have a separate folder, named by its language code in ISO 639-1 format:
docs/
  en/...
  he/...
  ...
  • there should be a separate index.json and search-index.json per each language.
    The current process of the building of the doc sheet path should be changed. path property should be computed using the convention: /docs/${language}/${domainName}/${method/property -Name}

  • language code should be added in the route path and read from there.
    I would really like to have separate subdomains, but I just cannot afford it at this moment
    We might want to have no language code for the English version to keep URL simple. Also, see Simplify docs' URL #102
    Examples:

    • https://js-tldr.info/docs/ - for English
    • https://js-tldr.info/he/docs/ - for Hebrew
    • https://js-tldr.info/uk/docs/ - for Ukrainian
@RusinovAnton RusinovAnton created this issue from a note in @1.0.0 (To do) Nov 12, 2019
@AlinaAlef
Copy link

🙋🏽‍♀️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Goodness Squad 23.07
  
In progress
@1.0.0
  
To do
Development

No branches or pull requests

2 participants