-
Notifications
You must be signed in to change notification settings - Fork 1
Documentation #101
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
Documentation #101
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Splits the bloated main README into focused subcommand guides, enriches the --input flag documentation, and adds details for the VN2 scenario.
- Introduced a standalone JSON schema reference in
v1_json_file_format.md. - Added separate docs for
katapolicygen,acipolicygen, andacifragmentgencommands. - Extracted common concepts to
common.mdand expanded enforcement point reference.
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/confcom/azext_confcom/docs/v1_json_file_format.md | Detailed JSON input schema reference |
| src/confcom/azext_confcom/docs/katapolicygen.md | CLI examples for katapolicygen |
| src/confcom/azext_confcom/docs/common.md | Extracted common documentation |
| src/confcom/azext_confcom/docs/acipolicygen.md | CLI examples with --input and VN2 scenario |
| src/confcom/azext_confcom/docs/acifragmentgen.md | CLI examples for acifragmentgen |
| src/confcom/azext_confcom/docs/Policy Enforcement Points.md | Framework rule reference and sample policy docs |
Comments suppressed due to low confidence (4)
src/confcom/azext_confcom/docs/acipolicygen.md:60
- [nitpick] For consistent styling, change "NOTE:" to "Note:" and correct the casing in "In most cases."
**NOTE:** Generating JSON policy is for use by the customer only, and is not used by ACI In most cases.
src/confcom/azext_confcom/docs/Policy Enforcement Points.md:364
- The flag is defined as
allow_dump_stackselsewhere; update this reference toallow_dump_stacksto match the actual rule name.
`allow_dump_stack` VS `dump_stack`
src/confcom/azext_confcom/docs/v1_json_file_format.md:55
- [nitpick] This subheading duplicates the top-level
fragmentsfield name and may confuse readers; consider renaming to something like "#### Fragment Object Definition".
#### fragments
src/confcom/azext_confcom/docs/common.md:10
- [nitpick] For consistency with other list items, add a trailing period.
This can be explored using `docker image inspect`
|
thoughts on having each example title in the ToC? makes for easy navigation |
ead1104 to
d031e45
Compare
2c06a36 to
8d28d85
Compare
The main README was getting bloated, so this splits it up into subcommands and adds more information about the
--inputflag as well as VN2