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

docs: secureli 540 update documentation #560

Merged
merged 3 commits into from
Jun 5, 2024

Conversation

itoltz
Copy link
Contributor

@itoltz itoltz commented Jun 4, 2024

secureli-540

This ticket was about a problem with configuring the pre-commit library. I determined that the issue was due to misconfiguration by the user, and the solution we settled on was to add documentation about how to specify args in the pre-commit library's configuration file.

Additionally, I updated headings throughout the file. Previously there were multiple H1s, and the License section was nested underneath the Configuration section. I've updated it so that there is only a single H1 heading--the title of the document--and the License section is now a sibling of configuration instead of a child.

Changes

  • Updated headings throughout the file
  • Added information and links for the pre-commit library
  • Added information about a quirk of how pre-commit handles parameters that take arguments

Testing

  • All changes are in documentation; no testing required or possible

Clean Code Checklist

  • Meets acceptance criteria for issue
  • New logic is covered with automated tests
  • Appropriate exception handling added
  • Thoughtful logging included
  • Documentation is updated
  • Follow-up work is documented in TODOs
  • TODOs have a ticket associated with them
  • No commented-out code included

A document should only have a single h1 heading.
I've kept the first H1 (the seCureLi title,
rendered here as an actual `<h1>` tag), and
increased the level of most other headings. The
only exception is the License heading, which had
previously been an H2 nested under the formerly-H1
Configuration heading. Now that Configuration is
an H2, the License section is a sibling instead of
a child of Configuration.
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

PR title failed to match (chore|style|test|feat|fix|docs|ci): .+

@itoltz itoltz changed the title Feature/secureli 540 update documentation docs: secureli 540 update documentation Jun 4, 2024
@github-actions github-actions bot dismissed their stale review June 4, 2024 19:53

All good!

Missed hyphens in two of the yaml examples
@itoltz itoltz merged commit b48109c into main Jun 5, 2024
5 checks passed
@itoltz itoltz deleted the feature/secureli-540-update-documentation branch June 5, 2024 16:49
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.

2 participants