docs(examples): Add Bazel example for core utilities #2022
Conversation
|
There was a problem hiding this comment.
Should we add a mention/link to the main docs to this example? If someone is reading the docs they won't know it exists unless they go browse the example dir in the repo.
I don't think we need to add a full blown section for now, but maybe a callout box along the lines of "Looking to use Bazel to bundle your function? Check this example in our repo" or similar.
|
At the moment we have this section: https://docs.powertools.aws.dev/lambda/java/latest/core/logging/#getting-started. Which references the examples folder on GitHub. Although this is only the case for the Logging utility. I don't think we should specifically highlight the Bazel example and not the other examples. One could argue why Bazel is more important than for example our Gradle or Kotlin examples. But I agree with your comment that the examples are not referenced in our documentation in a popular way. Do you have something in mind what we can do? Maybe on your homepage? We can add a box such as
|
|
Fair, then let's leave it as is for now. Not in this PR, but in the near future we could consider introducing a similar structure as we have in TypeScript with a "Getting Started" collection of pages, for example this one shows how to install different packages and this shows different patterns, and this one TypeScript settings. Obviously in the case of Java the content would be different, but this would probably be a good place to show these type of things, explain nuances around AspecJ, Crac, GraalVM, and similar things - in addition to utility-specific info on the respective pages. |
|
Thanks. I like these sections. |
Summary
This PR adds a new code example
sam-bazelshowcasing how to use the Core Utilities including AspectJ compile-time weaving using Bazel.Changes
Issue number: #2021
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.