diff --git a/.github/checklist.yml b/.github/checklist.yml index b32a25edfd5..0638afd89ce 100644 --- a/.github/checklist.yml +++ b/.github/checklist.yml @@ -2,6 +2,6 @@ paths: "assets/stylesheets/**": - Consider providing screenshots in a PR comment to show the difference visually "docs/*.asciidoc": - - Consider generating documentation locally to verify it is rendered correctly using `tools/generate-docs` + - Consider generating documentation locally to verify it is rendered correctly. See https://open.qa/docs/#_making_documentation_changes "external/**": - Consider doing this change in the upstream repository directly, see external/os-autoinst-common/README.md diff --git a/docs/Contributing.asciidoc b/docs/Contributing.asciidoc index 62dc57ef808..f9b0d79d29b 100644 --- a/docs/Contributing.asciidoc +++ b/docs/Contributing.asciidoc @@ -940,7 +940,7 @@ After changing documentation, consider generating documentation locally to verify it is rendered correctly using `tools/generate-docs`. It is possible to do that inside the provided development container by invoking: - podman run --rm -v OPENQA_LOCAL_CODE:/opt/openqa openqa_devel:latest make generate-docs + podman run --rm -v OPENQA_LOCAL_CODE:/opt/openqa registry.opensuse.org/devel/openqa/containers/opensuse/openqa_devel:latest make generate-docs Replace `OPENQA_LOCAL_CODE` with the location where you have the openQA code. The documentation will be built inside the container and put into `docs/build/`