Fixing Help typos and other errors

    From The Document Foundation Wiki

    Help contents are in XML and most of the editing is done by editing XML text. Typos and small issues can slip in. Thanks to translators, many errors are detected and reported.

    Fixing Help content issues

    The process is currently:

    • Translator picks the typo and reports to Weblate admin
    • Weblate admin forwards the report to documentation list
    • Doc coordinator picks up the issue and
    1. locates Weblate page
    2. identifies project/application/xhp page/string
    3. edits the xhp file in their local copy
    4. compiles help
    5. verifies correction in a local build of help, locating subject
    6. once verified, commits to local git copy
    7. submits to git/gerrit
    8. waits for approval or approves theirself
    • writes to doc list, the issue is fixed.

    Furthermore, the master help is ahead of the uploaded Weblate templates, which means an issue may be reported more than once and be fixed already. This is another waste of time.

    Proposed process


    Let the translator/volunteer correct the issue themself.


    1. install a VM for Help XML editing
    2. clone helpcontent2/
    3. install a PHP text editor (e.g. codiad or any other good text editor).
    4. control access to editor through username and password



    • Log-in to editor
    • Locate the page (ideally a link between Weblate UI and the help editor)
    • edit changes
    • save
    • log out


    Daily or weekly task

    1. Check the git diff of the corrections (under shell access)
    2. commit changes to local copy
    3. submit to gerrit with their key under "l10n team" authorship
    4. report to doc list


    • No way to compile the Help, but a skilled committer can inspect diff'ed and correct or approve
    • Committer handles git issues (pull, rebase, etc.)