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

Moving French Documentation to this repo #74

Open
dhanyatha-harish-ibigroup opened this issue Mar 3, 2023 · 4 comments
Open

Moving French Documentation to this repo #74

dhanyatha-harish-ibigroup opened this issue Mar 3, 2023 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@dhanyatha-harish-ibigroup
Copy link
Collaborator

French documentation is referenced from a different repository to enable Read the Docs to switch between English and French versions in the same link. Search an alternate solution so the french documentaion is under the same repository.

@dhanyatha-harish-ibigroup dhanyatha-harish-ibigroup added the documentation Improvements or additions to documentation label Mar 3, 2023
@dhanyatha-harish-ibigroup
Copy link
Collaborator Author

Content needs to be converted to a different language through a process by generating pot files and subproject to generate different language files. Transifex had to be used to convert the files and the method was not straight forward and it needed to opt for paid service. Easiest way is to use separate repositories since same repository and different language required to generate pot files. All the required URLs' are listed below:

  1. https://www.sphinx-doc.org/en/master/usage/advanced/intl.html
  2. https://sphinx-intl.readthedocs.io/en/master/quickstart.html
  3. https://docs.readthedocs.io/en/latest/localization.html
  4. https://github.com/effektif/user-docs/tree/master/docs
  5. Possible to create multiple projects from single repo? readthedocs/readthedocs.org#1554
  6. Sample proj - https://github.com/effektif/user-docs/tree/master/docs
  7. How to support another language readthedocs/readthedocs.org#4315

@cefect
Copy link
Collaborator

cefect commented Apr 4, 2023

Thanks for looking into this. I guess we keep the separate repo until RTD makes it a bit more user friendly. Can you add a section to ./docs/CONTRIBUTING.md giving a link to the french repo and explaining how it is linked in RTD.
Also, we should have a CONTRIBUTING.md on the french repo which explains the workflow for updating the french documentation (i.e., when there is an update to the english docs, how are these propagated into french).

@dhanyatha-harish-ibigroup
Copy link
Collaborator Author

A new french project was imported into Readthedocs from a different repository manually and configured it to language French (https://docs.readthedocs.io/en/stable/guides/git-integrations.html), changed the settings on readthedocs account to add Githubwebook under integrations and configuration under the translations, link the existing CanFlood English project with French.

@dhanyatha-harish-ibigroup
Copy link
Collaborator Author

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

No branches or pull requests

3 participants