docs(lint): add markdownlint rules and automation #1256
Merged
Conversation
This file contains 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
boring-cyborg
bot
added
documentation
pull-request-size
bot
added
the
size/XL
* develop: fix(ci): reusable workflow secrets param chore(deps-dev): bump flake8-bugbear from 22.4.25 to 22.6.22 (aws-powertools#1258) chore(deps-dev): bump mypy-boto3-dynamodb from 1.24.0 to 1.24.12 (aws-powertools#1255) chore(deps-dev): bump mypy-boto3-secretsmanager (aws-powertools#1252)
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
…s-lambda-powertools-python into docs/markdownlint * 'docs/markdownlint' of https://github.com/heitorlessa/aws-lambda-powertools-python:
boring-cyborg
bot
added
the
github-actions
heitorlessa
changed the title
heitorlessa
changed the title
…s-lambda-powertools-python into docs/markdownlint * 'docs/markdownlint' of https://github.com/heitorlessa/aws-lambda-powertools-python: feat(ci): include docs linting in make pr
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.
Issue number: #1009
Summary
Changes
This PR introduces Markdownlint with a slightly customized default rules available at
.markdownlint.yamlfile.Pre-commit hooks also include
markdownlintto ensure each documentation change follows these rules. Failing that locally, CI will runmarkdownlinton all markdown content available indocsfolder viamake lint-docs.For the future, it'd be great to create a custom rule to have a consistent one-line and multi-line admonitions. As of now, we use multi-line syntax only.
Additional tasks:
User experience
Checklist
If your change doesn't seem to apply, please leave them unchecked.
Is this a breaking change?
RFC issue number:
Checklist:
Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.
View rendered docs/changelog.md
View rendered docs/core/event_handler/api_gateway.md
View rendered docs/core/event_handler/appsync.md
View rendered docs/core/logger.md
View rendered docs/core/metrics.md
View rendered docs/core/tracer.md
View rendered docs/index.md
View rendered docs/roadmap.md
View rendered docs/tutorial/index.md
View rendered docs/utilities/batch.md
View rendered docs/utilities/feature_flags.md
View rendered docs/utilities/idempotency.md
View rendered docs/utilities/jmespath_functions.md
View rendered docs/utilities/parameters.md
View rendered docs/utilities/parser.md
View rendered docs/utilities/typing.md
View rendered docs/utilities/validation.md