Search⌘ K
AI Features

Dynamic Documentation and the Markdown Format

Explore how to automate dynamic network documentation using Ansible and Markdown. Learn to generate intent-based, human-readable documents that scale across devices, improving clarity and efficiency in managing network configurations.

Introduction

Now that the network has been converted to code, the data models can be used to create dynamic, automated documentation.

All the intent-based variables in the data models can be manipulated to create documentation files for each network device on the network. An Ansible playbook is created to build automated documentation based on intent and data models: documentation.yml. Network documentation is automated as part of the configuration management phase.

The output includes:

  • Dynamically generated intent-based configuration per device: ...