Chapter 9 Dynamic Intent-Based Documentation
For diagrams, tables, or exact code formatting, .
changed and is not idempotent, it is possible to use this differential to provide change management or operations, identifying what the difference is between the documentation and the running-configuration.
ansible-playbook documentation.yml –check -v ansible-playbook documentation.yml
Verify Output
After executing the documentation playbook make sure to use Git to commit all the generated output into the repository.
Git add * Git commit –a Git push All the automatically, dynamically, generated documentation is now part of the repository and available to be viewed either in TFS or VS Code. Browse to the output folders holding the configuration and Markdown files, exploring and validating them for accuracy. Using these files, it is possible to confirm exactly what will be pushed to the network in advance. Use this methodology to include artifacts along with pull requests to merge changes into the master branch. These artifacts can be easily read and understood by others in the change management approval flow or used by network operations on a day- to-day basis without needing to log onto the network.
