Skip to content
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

Revise https://etcd.io/docs/v3.5/tutorials/how-to-create-locks/ #794

Open
celestehorgan opened this issue Mar 18, 2024 · 4 comments
Open
Assignees
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@celestehorgan
Copy link

This one requires @wenjiaswe or other members of etcd as there's a bit of missing explanation I can't find anywhere else in the docs :)

This issue was created in preparation for the Contributor Summit docs sprint.

File: https://github.com/etcd-io/website/blob/main/content/en/docs/v3.6/tutorials/how-to-create-locks.md

Per #765, do the following:

  • Add prerequisites (etcdctl and a currently running etcd cluster are required)
  • Define all variables and flags used in the examples in a bulleted list (in this case, --endpoints, locks)
  • Explain in a bit more detail why you might want to create a lock (i.e., what kind of client needs this?) -- this is the part you'll need an etcd maintainer for
  • Maybe: Add a section on how to release a lock, as there does not appear to currently have one and I suspect you need one ;)

When done, the document should have the following sub-sections (## H2 headings):

  • Pre-requisites
  • Creating a lock
  • Releasing a lock (new section)
@nate-double-u nate-double-u added the help wanted Extra attention is needed label Mar 19, 2024
wenjiaswe added a commit that referenced this issue Mar 19, 2024
Part of KubeCon EU 24 doc sprint

#794
@jmhbnz jmhbnz added the good first issue Good for newcomers label Sep 12, 2024
@moficodes
Copy link
Member

Discussed during triage.
Need to copy the work from #808 and edit the same file for 3.5

@jmhbnz
Copy link
Member

jmhbnz commented Sep 12, 2024

cc @samuelbartels20

@samuelbartels20
Copy link

Please assign this ticket to me

@jmhbnz
Copy link
Member

jmhbnz commented Sep 12, 2024

/assign @samuelbartels20

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

5 participants