stackvana / hook.io

Open-Source Microservice Hosting Platform
https://hook.io
Other
1.27k stars 119 forks source link

Versioning of documentation and internationalization of docs #163

Open Marak opened 9 years ago

Marak commented 9 years ago

As per #156, we have begun to implement i18n support.

The /docs page ( main hook documentation ) will need to be translated.

The issue here is that our hook.io-i18n library really is geared more towards sentences, then entire paragraphs or sections. Documentation translations will suffer in quality if we are continually updating the documentation.

The best approach here is to create a separate repository for the documentation so we can track it's versioning. We'll work over the next month to generate a solid version 1.0.0 of documentation and we can begin international efforts on that version.

Moving forward after that, we can contain documentation updates to stable releases and notify our language contributors ahead of time.