Skip to content

chore: update docs #99

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

Merged
merged 3 commits into from
Apr 25, 2025
Merged

chore: update docs #99

merged 3 commits into from
Apr 25, 2025

Conversation

leoparente
Copy link
Contributor

This pull request updates the documentation for the device_discovery backend and the Git configuration manager. The changes enhance clarity, add new supported defaults, and provide additional examples for configuration. Below is a summary of the most important changes:

Updates to device_discovery documentation:

  • Added VLAN as a supported entity in the device_discovery backend, with a link to its documentation. (docs/backends/device_discovery.md)
  • Expanded the list of supported defaults to include if_type (interface type), role, tenant, and vrf for IP address and Prefix entities, as well as a comprehensive set of defaults for VLAN entities. (docs/backends/device_discovery.md) [1] [2]
  • Updated example configuration to include vlan settings under the defaults section. (docs/backends/device_discovery.md)

Updates to Git configuration documentation:

  • Added an important note clarifying that the config_manager and backends sections must be passed directly to the agent at startup since they are not dynamically reconfigurable. (docs/configs/git.md)
  • Introduced backends configuration examples for network_discovery and device_discovery. (docs/configs/git.md)
  • Provided a detailed example of a policy.yaml file, demonstrating how to declare the backend it applies to and configure schedules, defaults, and scope for device_discovery. (docs/configs/git.md)

@leoparente leoparente self-assigned this Apr 25, 2025
Copy link
Contributor

@jajeffries jajeffries left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@leoparente leoparente merged commit d51752c into develop Apr 25, 2025
4 checks passed
@leoparente leoparente deleted the chore/update_docs branch April 25, 2025 14:09
Copy link

🎉 This PR is included in version 2.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants