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

Translate Documentation #400

Open
7 tasks
apertureless opened this issue Aug 9, 2018 · 10 comments
Open
7 tasks

Translate Documentation #400

apertureless opened this issue Aug 9, 2018 · 10 comments

Comments

@apertureless
Copy link
Owner

apertureless commented Aug 9, 2018

So, it took a while but I have rewritten the documentation and ported it to VuePress.
I hope the structure is a bit better and a few more examples.

If you have any suggestions, please feel free to contribute!
And I always need help with translating!

Structure

The new structure is quite simple. The english documentation is under the /docs/ folder.

docs
├── README.md
├── guide
│   └── README.md
├── reference
│   └── README.md

The first README.md is the Landingpage.
Under /guide/ you will find the normal documentation with examples. Under /reference/ you will find some coding references, like public methods, props, events and so on.

Localization

Inside the docs folder you will find the subfolders for localization. For example zh-cn/, ja/, ru/ ... and so on. I've already created the folders and files. So if you want to contribute you only need to translate it inside your folder.

docs
├── README.md
├── reference
│   └── README.md
└── zh-cn
    ├── README.md
    ├── guide
    │   └── README.md
    └── reference
        └── README.md

Checklist for Contributors

  • Checkout develop
  • Run yarn docs:dev or npm run docs:dev
  • Translate Landingpage /README.md
  • Translate Guide /guide/README.md
  • Translate API Reference /api/README.md
  • Translate config.themeConfig.locales /.vuepress/config.js
  • Translate config.locales /.vuepress/config.js (description field)

Feel free to add additional languages!

@euledge
Copy link
Contributor

euledge commented Sep 23, 2018

of course I will help translating Japanese 👍

@guillecro
Copy link
Contributor

Good luck! Thou, have in mind that the doc is retrieving the latest dist of Docute.
I am going to send you a PR with the fixed URLs for the documentation to work properly!

@vinayakkulkarni
Copy link

Seems the docs are offline.

Uncaught ReferenceError: docute is not defined

@apertureless
Copy link
Owner Author

@vinayakkulkarni

Maybe clear your cache.
Docs are working fine after the merged PR from @guillecro

@apertureless
Copy link
Owner Author

Would be cool if you guys could help translating the new docs! 🙏

@zupolgec @amadeann @euledge @kylewelsby @chakan @music-mind @cugu @pushkyn @tesarwijaya @julienc91 @dood- @Mooooooon

@apertureless apertureless changed the title Move documentation to vuepress Translate Documentation Oct 20, 2018
@apertureless
Copy link
Owner Author

New docs are up now: https://vue-chartjs.org/

apertureless pushed a commit that referenced this issue Mar 18, 2019
* tlanslate landing page to Japanese #400

* tlanslate guide to Japanese #400

* tlanslate api docs to Japanese #400
apertureless added a commit that referenced this issue Jun 4, 2019
docs: Chinese docs #400
@apertureless
Copy link
Owner Author

Still looking for help for translations and improvements! 🍺

@rakvium
Copy link
Contributor

rakvium commented Oct 1, 2019

@apertureless I'm going to implement the Russian section.

@jotasies
Copy link

Hi all, I'm could give you some help with translation, this will be my first contribution to an open project but I'm sure I can help. I can work on the Spanish translation, in this specific case will be es-cr (Spanish Costa Rica), eventually could be the base for the other variations within Spanish as they could be a very reduce amount of changes from one variation to another.

@apertureless
Copy link
Owner Author

Updated vitepress and removed the old documentation.
If you want to contribute you can copy the de folder which will be the german translation as a base.

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

No branches or pull requests

6 participants