localstack-samples / localstack-samples/localstack-demo

docs: recommend using v3 for demo

Open
#74 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
69
Forks
33
Avg merge
6h 1m
Merged PRs (30d)
1

Description

The README suggests using the latest (from feb, 2023). I'd recommend removing this reference and suggesting the latest v3/v2 which have both been validated today.

https://github.com/localstack/localstack-demo/blob/43f0e840a5586f645cdc9b75eb463576728bc7e8/README.md?plain=1#L19

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open README.md around line 19, as linked in the issue, and review the wording about which version to use for the demo. Update the recommendation to refer to the validated v3/v2 versions, then check that the README no longer points users to the outdated February 2023 latest version.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.