Home

Help Needed

Migrating our new documentation from Google Docs to Docbook

Our documentation is maintained in an XML format known as DocBook. Docbook allows us to generate HTML and PDF versions of our documentation from a shared source. Since Docbook is a strict format, simply copying the documentation content into the Docbook source files isn't sufficient. You can use the instructions below to test as you work on moving the documentation over.

• Google Docs: https://drive.google.com/drive/folders/10nsLPokttFjG9g4x4mLBYNkTyO0izy5H
• GitHub: https://github.com/Xubuntu/xubuntu-docs/tree/docs-refresh

For an example, please see the following two commits:

1. https://github.com/Xubuntu/xubuntu-docs/commit/b37e641b5ef4a3a4f196b086912e59b68be4aefe
2. https://github.com/Xubuntu/xubuntu-docs/commit/5a69bf24b8e8999aa10f932dd942d0f3e4d2bb55

Please join us on Freenode at #xubuntu-devel if you have any questions.

Testing Validation

sudo apt install ubuntu-dev-tools default-jre docbook-xml docbook-xsl fonts-dejavu-core fonts-noto fop itstool libxml2-utils xsltproc
make clean
make user-get-translations
make contributor-get-translations TRANSPERC=20
make user-html
make user-html-translations
make contributor-html
make contributor-html-translations TRANSPERC=20
make startpage
make test