Skip to content

docs: Tracer example link goes to a 404 #414

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
merged 4 commits into from
Jan 7, 2022

Conversation

michaelbrewer
Copy link
Contributor

@michaelbrewer michaelbrewer commented Jan 5, 2022

Description of your changes

Changes:

  • Update tracer link to go to https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples/cdk/lib
  • Update docs to resolve lint errors

How to verify this change

Build and run the docs and click on the changed links.

PR status

Is this ready for review?: YES
Is it a breaking change?: NO

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • The code coverage hasn't decreased
  • I have added tests that prove my change is effective and works
  • New and existing unit tests pass locally and in Github Actions
  • Any dependent changes have been merged and published in downstream module
  • The PR title follows the conventional commit semantics

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 5, 2022
Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

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

Thanks a lot for the PR!

I left a couple of comments, one is just a note while the other is a change.

After addressing them, could you please update also the README.md files in each package?

This repo uses a monorepo structure and all packages are published on NPM separately so we need a README file in each one.

@michaelbrewer
Copy link
Contributor Author

@dreamorosi - i have updated the changes. FYI i am using markdownlint for editing and validating the MD files.

@michaelbrewer
Copy link
Contributor Author

@dreamorosi should all be resolved now

Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor

@ijemmy ijemmy left a comment

Choose a reason for hiding this comment

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

LGTM + installed markdownlint :) Thanks for the recommendation @michaelbrewer

@ijemmy ijemmy merged commit b1997af into aws-powertools:main Jan 7, 2022
@michaelbrewer michaelbrewer deleted the docs-fix-tracer-link branch January 7, 2022 16:00
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants