Skip to content

Cleanup the automation docs examples over all our docs #1338

@fjglira

Description

@fjglira

We should avoid the duplication of blocks in our ASCII docs automation, so we need to set new rules and modify the current testing scenarios that we have to follow this premise:

  • Execute always the code blocks from the test to validate each code block. No matter is a kubectl get pods, we should execute to be sure that the step command works
  • Only use the ifdef hidden blocks to run setups or validations for the test. This means avoid replicating code blocks that are already described in the docs

We will need to go over the current documentation to check this and do the proper modifications based on this premise

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions