Skip to content

Conversation

@dacharyc
Copy link
Collaborator

This PR adds two new commands to the audit-cli:

  • analyze procedures: get a breakdown of how many unique procedures exist in a file and its referenced includes, and what content selections they're tied to
  • extract procedures: create files representing each unique version of each procedure

We can use these commands to scope work and plan testing projects related to procedures. We can also potentially use the parser as a basis for future work related to procedure testing, so I've added extra documentation around the business logic for determining procedure uniqueness, reporting on them, etc.

Copy link
Collaborator

@krollins-mdb krollins-mdb left a comment

Choose a reason for hiding this comment

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

LGTM with just a couple comments. Would be good to have Cory or Caleb take a closer look.

- **Hash**: A short 6-character hash of the content (for uniqueness)

Examples:
- `before-you-begin-pull-the-mongodb-docker-image-e8eeec.rst`
Copy link
Collaborator

Choose a reason for hiding this comment

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

For legibility, could we use underscores between the different pieces of the filename? For example:
before-you-begin_pull-the-mongodb-docker-image_e8eeec.rst

I know that's a little odd convention-wise, but it would improve scanability if we're expecting people to reference the files.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Whew, this is a large file. Any way we can break it up a bit to improve maintainability?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants