Automate localized documentation updates #11477

Closed
nijel opened this Issue Sep 14, 2015 · 3 comments

Projects

None yet

2 participants

@nijel
Member
nijel commented Sep 14, 2015

Currently the localized documentation repository is synced with development one manually. This makes propagating of the changes quite slow, what can cause confusion, especially when fixing typos in the documentation.

This process could be automated:

  • Add GitHub hook for phpmyadmin repository
  • Detect changes in the doc/ folder in the master branch
  • Commit all pending translations in Weblate
  • Update the localized_docs repository to match phpmyadmin one
@nijel nijel self-assigned this Sep 14, 2015
@udan11
Member
udan11 commented Sep 14, 2015

What if the whole documentation (doc and examples) was moved outside from the phpMyAdmin repository and was included only as a submodule?

@nijel
Member
nijel commented Sep 14, 2015

That's option as well, but I'd say it's unrelated here - the .po files need to updated once we change the docs anyway.

@nijel nijel added a commit to phpmyadmin/scripts that closed this issue Dec 23, 2016
@nijel nijel Add script for automated localized_docs repo updates
Fixes phpmyadmin/phpmyadmin#11477

Signed-off-by: Michal Čihař <michal@cihar.com>
08da856
@nijel
Member
nijel commented Dec 23, 2016

The synchronization is now done daily (I've decided to do this daily rather than automatically on every commit as this could lead to too many commits without any real benefit), the localized_docs repo will get updates in case there are some changes in the docs in master.

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