Note down the migration
For the basic setup you basically need to care about:
- Makefiles to simplifiy build (not strictly necessary). Kdenlive has two a "normal" one and a
make.bat
for windows - The sphinx configuration in conf.py. With the comments there it should be mostly self explaining.
- As you can see in the config we have some custom css/js on top of the
sphinx_rtd_theme
theme in the resources folder. These customizations are mainly for the language switcher and for the panels on the start page: F10862916: grafik.png The favicons do also live here. We also customzie the footer and add a header for matomo tracking with https://stats.kde.org/ (if you are interested in this, you need to coordinate with sysadmins. You should not use the same code as kdenlive as eg. the side ID it is specific to the kdenlive manual) -
.gitignore
to avoid commiting build results of local builds - For translations a StaticMessages.sh file. See these commits: 87b06ee5, a5e8ea28
- As Eugen said we migrated from the wiki and I wrote some python scripts to automatically convert the content. They live in https://invent.kde.org/documentation/docs-kdenlive-org/-/tree/master/tools. However since you migrate form DocBook you either need to tweak the scripts or to it manually.
- Add a 404handler.php this will also take care of choosing the currect default language based on the browser language for the user.
- Concerning tests, we only have one to make sure that file paths are not to long as this will cause problems with Scripty.
On the infrastuture part it is:
- Ask Sysadmins to setup the domain
- Ask sysadmins to configure on the serverside to use
404handler.php
- Make sure the repo is correctly registered (especally the i18n part). Sysadmins now about details. See this commit
- Enable Scripty for translations on the documentation repository as done in this commit (in dough ask the i18n team for help)
- Add Jenkins job that takes care of building and publishing with a sniped like
`
{
"name": "docs-kdenlive-org","repository": "documentation/docs-kdenlive-org",
"branch": "master",
"cron": "",
"type": "sphinx-app-docs",
"deploylangs": "en de fr nl es tr da pt_BR ru uk_UA zh_CN zh_TW ja ko ca sk sv it",
"deploypath": "/srv/www/generated/docs.kdenlive.org/"
}
added to https://invent.kde.org/sysadmin/binary-factory-tooling/-/blob/master/staticweb/custom-jobs.json
Not sure if I forgot anything, but thats all I can recall right now. Hope that helps.
Edited by Eugen Mohr