Skip to content

Conversation

@SethHollandsworth
Copy link
Owner

The main README was getting bloated, so this splits it up into subcommands and adds more information about the --input flag as well as VN2

@SethHollandsworth SethHollandsworth self-assigned this Jun 12, 2025
@SethHollandsworth SethHollandsworth added the documentation Improvements or additions to documentation label Jun 12, 2025
Copy link

Copilot AI left a 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, and acifragmentgen commands.
  • Extracted common concepts to common.md and 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_stacks elsewhere; update this reference to allow_dump_stacks to 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 fragments field 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
Copy link
Collaborator

ksayid commented Jun 16, 2025

thoughts on having each example title in the ToC? makes for easy navigation

@ksayid ksayid self-requested a review June 16, 2025 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants