Documentation#101
Merged
SethHollandsworth merged 1 commit intomainfrom Jul 23, 2025
Merged
Conversation
There was a problem hiding this comment.
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`
ksayid
reviewed
Jun 12, 2025
ksayid
reviewed
Jun 12, 2025
ksayid
reviewed
Jun 12, 2025
ksayid
reviewed
Jun 12, 2025
ksayid
reviewed
Jun 12, 2025
ksayid
reviewed
Jun 12, 2025
ksayid
reviewed
Jun 12, 2025
ksayid
reviewed
Jun 12, 2025
ksayid
reviewed
Jun 12, 2025
ksayid
reviewed
Jun 12, 2025
ksayid
reviewed
Jun 12, 2025
Collaborator
|
thoughts on having each example title in the ToC? makes for easy navigation |
ksayid
reviewed
Jun 16, 2025
ksayid
reviewed
Jun 16, 2025
ksayid
approved these changes
Jun 16, 2025
hgarvison
reviewed
Jun 24, 2025
hgarvison
reviewed
Jun 24, 2025
hgarvison
reviewed
Jun 24, 2025
hgarvison
reviewed
Jun 24, 2025
hgarvison
reviewed
Jun 24, 2025
hgarvison
reviewed
Jun 24, 2025
hgarvison
reviewed
Jun 24, 2025
hgarvison
reviewed
Jun 24, 2025
hgarvison
reviewed
Jun 24, 2025
hgarvison
reviewed
Jun 24, 2025
hgarvison
reviewed
Jun 24, 2025
hgarvison
reviewed
Jun 24, 2025
hgarvison
reviewed
Jul 22, 2025
hgarvison
reviewed
Jul 22, 2025
hgarvison
reviewed
Jul 22, 2025
hgarvison
approved these changes
Jul 23, 2025
ead1104 to
d031e45
Compare
2c06a36 to
8d28d85
Compare
This was referenced Jul 25, 2025
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
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.
The main README was getting bloated, so this splits it up into subcommands and adds more information about the
--inputflag as well as VN2