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

Automatic testing of documentation #454

Open
dgn opened this issue Oct 28, 2024 · 0 comments
Open

Automatic testing of documentation #454

dgn opened this issue Oct 28, 2024 · 0 comments
Labels
enhancement New feature or request test-needed
Milestone

Comments

@dgn
Copy link
Collaborator

dgn commented Oct 28, 2024

We should make sure to have automated tests for our documentation, so that

  • we can be sure the steps in our documentation are working as expected and
  • we don't make changes to the code that accidentally cause a change in behavior

Istio is automatically testing the instructions in their documentation, maybe we can draw some inspiration from their solution.

@dgn dgn added this to the v1.0 milestone Oct 28, 2024
@dgn dgn added the enhancement New feature or request label Oct 28, 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 test-needed
Projects
None yet
Development

No branches or pull requests

2 participants