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.

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

Automated tests of the user documentation #372

Open
3 tasks
inf17101 opened this issue Sep 5, 2024 · 0 comments
Open
3 tasks

Automated tests of the user documentation #372

inf17101 opened this issue Sep 5, 2024 · 0 comments
Labels
enhancement New feature or request. Issue will appear in the change log "Features"
Milestone

Comments

@inf17101
Copy link
Contributor

inf17101 commented Sep 5, 2024

Description

Prevent wrong user documentation content or invalid links by testing the user documentation automatically.

There is also a package available for the mike package which can test links inside the documentation. This needs to be tested and checked.

Goals

Automated tests for the user documentation.

Final result

Summary

To be filled when the final solution is sketched.

Tasks

  • Create a concept for testing the user doc automatically within CI/CD
  • Remove or update not needed and obsolete chapters like: test coverage, unit test execution => here old commands are mentioned and not the usage of the tools/*.sh scripts which shall be used to execute coverage and tests, because the tool scripts do preparation steps or contain important exclusions.
  • Implement & test the concept
@inf17101 inf17101 added the enhancement New feature or request. Issue will appear in the change log "Features" label Sep 5, 2024
@krucod3 krucod3 added this to the v0.6 milestone Sep 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request. Issue will appear in the change log "Features"
Projects
None yet
Development

No branches or pull requests

2 participants