Skip to content
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

Update function docs #114

Merged
merged 15 commits into from
Feb 26, 2024
Merged

Update function docs #114

merged 15 commits into from
Feb 26, 2024

Conversation

jakehildreth
Copy link
Owner

Used Copilot to add comment-based help to everything. It's not the best, but it's better than nothing!

@jakehildreth
Copy link
Owner Author

Issue #115 supports this.

@SamErde SamErde changed the base branch from main to testing February 26, 2024 11:17
@SamErde SamErde added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 26, 2024
Made the synopsis consistent with other Find-ESC functions. Moved the details to the description.
Made the synopsis consistent with other Find-ESC synopsis by specifying which vulnerability it is checking for. ("This script finds AD CS (Active Directory Certificate Services) objects that have the ESC5 vulnerability.")
Copy link

github-actions bot commented Feb 26, 2024

🦙 MegaLinter status: ⚠️ WARNING

Descriptor Linter Files Fixed Errors Elapsed time
⚠️ COPYPASTE jscpd yes 19 1.97s
⚠️ EDITORCONFIG editorconfig-checker 23 1 0.37s
⚠️ MARKDOWN markdownlint 1 11 0.84s
⚠️ MARKDOWN markdown-link-check 1 9 3.06s
✅ MARKDOWN markdown-table-formatter 1 0 0.42s
⚠️ POWERSHELL powershell 22 15 29.6s
✅ POWERSHELL powershell_formatter 22 0 19.94s
⚠️ REPOSITORY checkov yes 1 11.24s
✅ REPOSITORY gitleaks yes no 0.36s
✅ REPOSITORY git_diff yes no 0.0s
✅ REPOSITORY grype yes no 13.62s
✅ REPOSITORY secretlint yes no 0.79s
✅ REPOSITORY trivy yes no 5.69s
✅ REPOSITORY trivy-sbom yes no 2.7s
✅ REPOSITORY trufflehog yes no 8.09s
⚠️ SPELL cspell 24 154 4.9s

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by OX Security

A nitpick, but CGPT used lowercase "$issue" in the examples while it is titlecase "$Issue" everywhere else.
Made indentation consistent with other CBH blocks.
Made indentation consistent with other CBH blocks.
Removed prompt characters from example code.
Removed '.ps1' from the example function.
Consistent indentation in CBH.
Removed prompt characters from examples.
Copy link
Collaborator

@SamErde SamErde left a comment

Choose a reason for hiding this comment

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

Several of the functions had redundant CmdletBinding and param () blocks added in this PR and need to be removed carefully.

Style question: what is a good way that we can distinguish commands, their output, and the description text for example blocks? I do like the way that most seem to have a blank link between the example command and the example description. Others have no distinguishing paragraph breaks between the example, the example output, and the description.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Do you want to align the ESC8 synopsis with the prior ones ("This script finds AD CS (Active Directory Certificate Services) objects that have the ESC8 vulnerability.") or is this one a unique case given the different types of checks that could be performed?

@jakehildreth
Copy link
Owner Author

Several of the functions had redundant CmdletBinding and param () blocks added in this PR and need to be removed carefully.

Removed! If they are all gone to your satisfaction, please to be approving.

Style question: what is a good way that we can distinguish commands, their output, and the description text for example blocks? I do like the way that most seem to have a blank link between the example command and the example description. Others have no distinguishing paragraph breaks between the example, the example output, and the description.

We can talk about this in Friday's meeting and decide on a standard. And if there's a definite style guide we want to follow, pls lmk!

TrimarcJake and others added 5 commits February 26, 2024 06:39
Copy link
Collaborator

@SamErde SamErde left a comment

Choose a reason for hiding this comment

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

LGTM!

@jakehildreth jakehildreth merged commit cdcdeba into testing Feb 26, 2024
3 checks passed
@jakehildreth jakehildreth deleted the update-function-docs branch March 2, 2024 15:49
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants