Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Slightly improve generate-docs help #6147

Merged
merged 1 commit into from
Jan 31, 2025
Merged

Slightly improve generate-docs help #6147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/checklist.yml
View file
Open in desktop
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
View file
Open in desktop
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