docs: add prerequisites, examples, and release info to locks tutorial#1121
docs: add prerequisites, examples, and release info to locks tutorial#1121akshatj536 wants to merge 1 commit intoetcd-io:mainfrom
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: akshatj536 The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Hi @akshatj536. Thanks for your PR. I'm waiting for a etcd-io member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
Signed-off-by: Akshat Jain <akshat2510jain@gmail.com>
2929fbf to
80f5484
Compare
|
|
||
| ### Visual demonstration | ||
|
|
||
|  |
There was a problem hiding this comment.
In general, we don't recommend using GIF formats due to issues with maintainability, large file sizes, and lack of accessibility. Could you please consider explaining the guidance thoroughly in the written content first, and removing the GIF from this section?
|
I’ll loop in @ronaldngounou for review since he worked on improving this guidance before. Hi Ronald, could you please help review this PR when you have time? Thank you. |
| etcdctl --endpoints=$ENDPOINTS lock mutex1 | ||
| etcdctl --endpoints=$ENDPOINTS lock mutex1 echo "Lock acquired" |
There was a problem hiding this comment.
Hey, this example is wrong, because the original tutorial is wrong. For this form of the lock, you need to actually send etcd a command, like updating a key.
| ## Prerequisites | ||
|
|
||
| * Install [`etcd` and `etcdctl`](https://etcd.io/docs/v3.6/install/) | ||
| * A running etcd cluster (see [How to Set Up a Demo etcd Cluster](/docs/v3.6/tasks/operator/how-to-setup-cluster/)) |
There was a problem hiding this comment.
I'd like to see more here for setup. For example, the user will need to have multiple, separate shell sessions with etcdctl clients in order to try this out.
Summary
Adds missing prerequisites, command execution example, and lock release documentation to the locks tutorial.
Changes
--endpointsand--ttloptionsContext
Addresses part of #794 by filling straightforward documentation gaps. Further improvements (multi-client examples, detailed mechanics) will follow in subsequent PRs.
Testing
npm run serve