Skip to content

Commit

Permalink
Slightly improve generate-docs help
Browse files Browse the repository at this point in the history
  • Loading branch information
perlpunk committed Jan 30, 2025
1 parent b2ad1dc commit e286365
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/checklist.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/Contributing.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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/`
Expand Down

0 comments on commit e286365

Please sign in to comment.