Skip to content

docs: Examples should link to the latest tagged version #1336

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

Closed
1 task done
scottgerring opened this issue Aug 2, 2023 · 1 comment
Closed
1 task done

docs: Examples should link to the latest tagged version #1336

scottgerring opened this issue Aug 2, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation good-first-issue Good for newcomers

Comments

@scottgerring
Copy link
Contributor

What were you searching in the docs?

If I check out an example POM on main, I find dependencies pointing at a SNAPSHOT version. These are not cloneable as is, and won't compile, because we don't publish SNAPSHOTs.

Is this related to an existing documentation section?

No response

How can we improve?

We should make documentation point to the latest tagged examples version, so it is easy to find what needs to be copied to get started. E.g.:

https://github.com/aws-powertools/powertools-lambda-java/tree/v1.16.1/examples

Got a suggestion in mind?

No response

Acknowledgment

  • I understand the final update might be different from my proposed suggestion, or refused.
@scottgerring scottgerring added documentation Improvements or additions to documentation good-first-issue Good for newcomers triage labels Aug 2, 2023
@scottgerring scottgerring changed the title Docs: Examples should link to the latest tagged version docs: Examples should link to the latest tagged version Aug 16, 2023
@scottgerring scottgerring self-assigned this Aug 17, 2023
@scottgerring scottgerring moved this from Working on it to Pending review in Powertools for AWS Lambda (Java) Aug 17, 2023
Copy link
Contributor

This is now released under 1.18.0 version!

@jeromevdl jeromevdl moved this from Pending review to Shipped in Powertools for AWS Lambda (Java) Sep 2, 2024
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 good-first-issue Good for newcomers
Projects
Status: Shipped
Development

No branches or pull requests

1 participant