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

Multi lingual documentation #21

Open
jooola opened this issue Nov 18, 2021 · 7 comments
Open

Multi lingual documentation #21

jooola opened this issue Nov 18, 2021 · 7 comments
Assignees
Labels
help wanted Extra attention is needed

Comments

@jooola
Copy link
Contributor

jooola commented Nov 18, 2021

Having a multi lingual documentation would be awesome after the documentation has been rewritten and modernized.

This has been requested by french people willing to learn how Libretime works.

We should focus the user manual, not necessarily the admin/dev/advanced guides/manual, as we expect admin that install the server to understand English.

This is a long term goal.

@zklosko
Copy link
Member

zklosko commented Dec 22, 2021

That's a very important thing we need to work on. I'll pin this so it doesn't go anywhere.

@zklosko
Copy link
Member

zklosko commented Jan 15, 2022

I just heard of Docusaurus, a documentation-focuses SSG that uses React as its base. It has a lot of features we're looking for: search plugin without 3rd party clouds, i18n, syntax highlighting, and easy CI/CD. If anyone's interested, I have a demo here which is somewhat completed.

@paddatrapper
Copy link
Contributor

That 404s?

@zklosko
Copy link
Member

zklosko commented Jan 15, 2022

My bad. Try again.

@paddatrapper
Copy link
Contributor

That's pretty cool! I want to have a look at the code at some point, but the final product is nice and sleek. Having a blog section also appeals to me because it would be a nice way to highlight some use-cases, new features, etc as we develop them

@zklosko zklosko self-assigned this Jan 15, 2022
@jooola
Copy link
Contributor Author

jooola commented Jan 15, 2022

Cool site, Docusaurus seem like a nice tool, I overlooked it while searching for Jekyll alternative, another candidate I had was Vuepress which isn't yet as powerful.

I never used MDX, it brings a lot of features material/mkdocs was providing, this is a good thing.

I guess this overlaps with the previous #8 ? @zklosko Maybe you can move this discussion there ?

@zklosko
Copy link
Member

zklosko commented Feb 23, 2022

Update for those just finding this: We've successfully merged in Docusaurus and we're looking for people who can write translations for the documentation.

@jooola jooola transferred this issue from libretime/libretime Mar 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants