Skip to content

docs(metrics): snippets split, improved, and lint #1286

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

Merged

Conversation

heitorlessa
Copy link
Contributor

@heitorlessa heitorlessa commented Jul 8, 2022

Issue number: #1285

Summary

Changes

Please provide a summary of what's being changed

Changes snippet fictitious names for actual code snippet filenames to ease discoverability, and ease collaboration to improve/fix doc snippets.

Before

image

image

After

image

image

User experience

Please share what the user experience looks like before and after this change

Checklist

If your change doesn't seem to apply, please leave them unchecked.

Is this a breaking change?

RFC issue number:

Checklist:

  • Migration process documented
  • Implement warnings (if it can live side by side)

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/core/event_handler/api_gateway.md
View rendered docs/core/logger.md
View rendered docs/core/metrics.md
View rendered docs/core/tracer.md

@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jul 8, 2022
@pull-request-size pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 8, 2022
@heitorlessa heitorlessa merged commit fef70b0 into aws-powertools:develop Jul 8, 2022
@heitorlessa heitorlessa deleted the docs/align-snippet-filename branch July 8, 2022 14:00
heitorlessa added a commit to heitorlessa/aws-lambda-powertools-python that referenced this pull request Jul 8, 2022
* develop:
  fix(ci): accept core arg in label related issue workflow
  docs(core): match code snippet name with filename (aws-powertools#1286)
  fix: sight, yes a whitespace character breaks the build
  fix: mathc the name of the cdk synth from the build phase
  fix: download artefact into the layer dir
@heitorlessa heitorlessa changed the title docs(core): match code snippet name with filename docs(metrics): snippets split, improved, and lint Jul 13, 2022
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 size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant