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

docs: add french user-manual translations #1876

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

jooola
Copy link
Contributor

@jooola jooola commented Jun 14, 2022

No description provided.

@jooola
Copy link
Contributor Author

jooola commented Jun 24, 2022

The screenshot aren't translated, and I don't know how to best handle them. Should we change the paths pointing to them, or should we create symlinks to the existing files ?

I will try changing the paths, hope docusaurus handle well the multiple path computation.

@jooola
Copy link
Contributor Author

jooola commented Jun 24, 2022

It seems we cannot have a partially translated documentation.

Seems like if we only translate the user-manual, some link from the admin-manual to the user-manual will be broken.

image

I already use a really long relative path to get the untranslated screenshots, which seem a bit dirty.
image

@jooola jooola force-pushed the docs_fr branch 3 times, most recently from d0c51bc to e25e6c1 Compare June 27, 2022 09:00
@jooola
Copy link
Contributor Author

jooola commented Jun 27, 2022

/website-preview

@github-actions
Copy link

🚀 Preview deployment succeeded!

Website preview: https://libretime.github.io/pr-1876/
New docs preview: https://libretime.github.io/pr-1876/docs/next/
Workflow: https://github.com/libretime/libretime/actions/runs/2568017665

@jooola
Copy link
Contributor Author

jooola commented Jun 27, 2022

/website-preview

@github-actions
Copy link

🚀 Preview deployment succeeded!

Website preview: https://libretime.github.io/pr-1876/
New docs preview: https://libretime.github.io/pr-1876/docs/next/
Workflow: https://github.com/libretime/libretime/actions/runs/2568112763

@jooola
Copy link
Contributor Author

jooola commented Jun 27, 2022

Docusaurus does not support partially translated documentation.

I feel this is gonna be a nightmare to maintain, we currently duplicate all the documentation once again, and we are starting to have a matrix of languages / versions to maintain which I think should not be handled inside the repository (#1913).

I don't know if this complexity comes specially from docusaurus or any multilingual system, but I'll try to experiment with mkdocs/sphinx to see if they have a better way for handling this.

Maybe once we remove the version from the matrix, we will be able to have something simpler.

@jooola
Copy link
Contributor Author

jooola commented Jun 27, 2022

In addition, keeping track of the changes between multiple languages seem also to be a complex topic.

We might want to extract the translated documentation to it's own repository, and use a bot to raise issues if we detect changes on the default documentation.

@jooola
Copy link
Contributor Author

jooola commented Sep 12, 2022

I think this should go in a dedicated repository, with it's own name spaced URL e.g. /fr/.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant