Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-84211

As documentation engineer I want a deterministic and fully automated environment for testing and publishing docs, docsite changes, and qdoc

    XMLWordPrintable

Details

    • User Story
    • Resolution: Unresolved
    • P2: Important
    • None
    • None
    • None

    Description

      The benefit of a fully automated and deterministic environment is that it

      • removes "it works on my machine" type bugs
      • provides comparable results
      • can be kept more or less entirely in code
      • creates transparency around processes and tools
      • encourages knowledge sharing
      • makes it easier to test changes or experiment with ideas
      • introduces reproducible and deterministic ways to test doc artifacts
      • may be used in fully automated publishing of documentation

      The primary users are the Qt Company's documentation engineers, in the role of "internal customer".

      The initial implementation should aim at delivering a platform that can build and run the test suite for QDoc with code coverage, and upload the coverage report to doc.qt.io. This must be in a form that allows the current Rundeck scheduling system to schedule generation of said reports at least once per day. The suggested approach is a combination of Vagrant and Ansible, as these tools are already in use in other parts of our organization.

      Attachments

        For Gerrit Dashboard: QTBUG-84211
        # Subject Branch Project Status CR V

        Activity

          People

            docinfrastructure Documentation Infrastructure Team
            paulwicking Paul Wicking
            Tino Pyssysalo Tino Pyssysalo
            Paul Wicking Paul Wicking
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:

              Gerrit Reviews

                There are no open Gerrit changes