[libvirt PATCH 00/10] docs: Expand documentation on the CI/testing topic

Erik Skultety eskultet at redhat.com
Tue Jul 12 12:44:32 UTC 2022


This series was inspired by QEMU's documentation on CI and focuses on the
following:
- adds documentation on how to add a custom runner to the libvirt project or
  its fork, mainly in context of running functional testing
- replaces the old 'testsuites' article with a more detailed landing page
describing different types of testing available in libvirt
- updates the TCK documentation with details on how TCK should be installed
  and used nowadays

For sure we can add lots more content related to testing in libvirt but I think
this series provides a solid foundation that can be easily expanded on in the
future.

Here's the website build artifact to see what it'll look like eventually:
https://gitlab.com/eskultety/libvirt/-/jobs/2709823650

Erik Skultety (10):
  docs: Move the CI dashboard to its own RST module
  docs: Provide more information about the TCK test suite
  docs: Provide an article on how to add a custom runner to the project
  docs: Provide an article on testing
  docs: Replace testsuites article with the new 'testing' article
  docs: Drop the testsuites article
  docs: Change the CI headline from "CI Testing" to "CI"
  docs: ci: Add info about the two major types of jobs our CI runs
  docs: ci: Add a section on how to add a new platform to libvirt CI
  docs: ci: Add a brief section on how to run the CI workload locally

 docs/ci-dashboard.rst | 216 +++++++++++++++++++++++++++++++++++
 docs/ci-runners.rst   |  86 ++++++++++++++
 docs/ci.rst           | 255 +++++++++++-------------------------------
 docs/docs.rst         |  10 +-
 docs/meson.build      |   4 +-
 docs/testing.rst      | 176 +++++++++++++++++++++++++++++
 docs/testsuites.rst   |  37 ------
 docs/testtck.rst      |  92 +++++++++++++--
 8 files changed, 631 insertions(+), 245 deletions(-)
 create mode 100644 docs/ci-dashboard.rst
 create mode 100644 docs/ci-runners.rst
 create mode 100644 docs/testing.rst
 delete mode 100644 docs/testsuites.rst

-- 
2.36.1



More information about the libvir-list mailing list