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

Election example not clear #787

Open
pgodfrin-nov opened this issue Mar 13, 2024 · 7 comments
Open

Election example not clear #787

pgodfrin-nov opened this issue Mar 13, 2024 · 7 comments
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@pgodfrin-nov
Copy link

Howdy - perhaps the doc could define what the arguments mean? What is "one" and what is "p1" and "p2"??

@jmhbnz
Copy link
Member

jmhbnz commented May 5, 2024

Hey @pgodfrin-nov - Thanks for raising this suggestion, can you please confirm which page you're referring to? Thanks!

@jmhbnz jmhbnz added enhancement New feature or request needs-info labels May 5, 2024
@pgodfrin-nov
Copy link
Author

Hey @pgodfrin-nov - Thanks for raising this suggestion, can you please confirm which page you're referring to? Thanks!

Certainly, not sure why I didn't in the first place...
https://etcd.io/docs/v3.5/tutorials/how-to-conduct-elections/

@jmhbnz jmhbnz added help wanted Extra attention is needed good first issue Good for newcomers and removed needs-info labels May 6, 2024
@Shubhdeep02
Copy link
Contributor

Hey @jmhbnz i would like to work on this issue..

@jmhbnz
Copy link
Member

jmhbnz commented Jun 21, 2024

Hey @jmhbnz i would like to work on this issue..

Awesome - thanks!

/assign @Shubhdeep02

@Shubhdeep02
Copy link
Contributor

hey @jmhbnz should i add a complete block of how notation are given and used or just refactor it by adding comments?

@jmhbnz
Copy link
Member

jmhbnz commented Jun 22, 2024

hey @jmhbnz should i add a complete block of how notation are given and used or just refactor it by adding comments?

I would suggest rewriting the page to remove the current .gif image and replace it with step by step instructions. The gif does not work with screen readers etc and may go to fast to be clearly understood.

@Shubhdeep02
Copy link
Contributor

@jmhbnz i have raised the pr in #867 . Can you please review it?

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

No branches or pull requests

3 participants