-
Notifications
You must be signed in to change notification settings - Fork 174
chore: add AWS bootstrap js + update url refs #4614
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
base: main
Are you sure you want to change the base?
Conversation
|
Please review this @sdangol. |
### Escape hatch mechanism | ||
|
||
You can use `tracer.provider` attribute to access [a subset of the methods provided](https://docs.powertools.aws.dev/lambda/typescript/latest/api/classes/_aws_lambda_powertools_tracer.provider_ProviderService.ProviderService.html) by the [AWS X-Ray SDK](https://docs.aws.amazon.com/xray-sdk-for-nodejs/latest/reference/AWSXRay.html). | ||
You can use `tracer.provider` attribute to access [a subset of the methods provided](https://docs.aws.amazon.com/powertools/typescript/latest/api/classes/_aws_lambda_powertools_tracer.provider_ProviderService.ProviderService.html) by the [AWS X-Ray SDK](https://docs.aws.amazon.com/xray-sdk-for-nodejs/latest/reference/AWSXRay.html). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This url is not working, it expects _aws_lambda_powertools
(underscore) but the url is now resolving _aws-lambda-
(dash)
Not working: https://docs.aws.amazon.com/powertools/typescript/latest/api/classes/_aws-lambda-powertools_tracer.provider_ProviderService.ProviderService.html
working: https://docs.aws.amazon.com/powertools/typescript/latest/api/classes/_aws-lambda-powertools_tracer.provider_ProviderService.ProviderService.html
* | ||
* By default, you can use any of the {@link https://jmespath.org/specification.html | JMESPath built-in functions} as well as the | ||
* {@link https://docs.powertools.aws.dev/lambda/typescript/latest/api/classes/_aws_lambda_powertools_jmespath.PowertoolsFunctions.PowertoolsFunctions.html | custom functions provided} | ||
* {@link https://docs.aws.amazon.com/powertools/typescript/latest/api/classes/_aws_lambda_powertools_jmespath.PowertoolsFunctions.PowertoolsFunctions.html | custom functions provided} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same issue with url here.
You can customize most of the configuration options of the table, i.e the names of the attributes. | ||
See | ||
the [API documentation](https://docs.powertools.aws.dev/lambda/typescript/latest/api/types/_aws_lambda_powertools_idempotency.types.DynamoDBPersistenceOptions.html) | ||
the [API documentation](https://docs.aws.amazon.com/powertools/typescript/latest/api/types/_aws_lambda_powertools_idempotency.types.DynamoDBPersistenceOptions.html) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Url issue same as above
Do we want to make these URL's versioned instead of using /latest in them? |
We don't have a process to update them when we release, and they work at the best of my knowledge. For now I'd leave them like this, so we can get the analytics going. |
Summary
Changes
This PR adds the AWS bootstrap JS file to the docs pages and also updates the base URL for the docs in all occurrences throughout the codebase.
For an easier review, I suggest to focus on the first commit, which adds the bootstrap script.
The second commit is an automated find & replace with the old and new url respectively.
The third commit removes the now outdated analytics script.
The fourth commit updates the Discord badge button with a working image.
Issue number: closes #4611
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.