policy_*.py example scripts: Add documentation #200
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add documentation for the Github pages site for policy_*.py example scripts.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for policy-related example scripts to the GitHub pages site. The purpose is to provide comprehensive documentation for users to understand and use the policy management scripts effectively.
Key changes:
- Added navigation entries for four policy scripts in the documentation site
- Created detailed documentation files for each policy script with usage examples and expected outputs
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Added navigation entries for four new policy script documentation pages |
| docs/scripts/policy_create.md | Documentation for creating policies with examples and error scenarios |
| docs/scripts/policy_delete.md | Documentation for deleting policies with examples and error scenarios |
| docs/scripts/policy_info_switch.md | Documentation for retrieving policy information from switches |
| docs/scripts/policy_info_switch_generated_config.md | Documentation for retrieving generated config from switch policies |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add documentation for the Github pages site for policy_*.py example scripts.