website icon indicating copy to clipboard operation
website copied to clipboard

Election example not clear

Open pgodfrin-nov opened this issue 1 year ago • 7 comments

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

pgodfrin-nov avatar Mar 13 '24 12:03 pgodfrin-nov

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

jmhbnz avatar May 05 '24 09:05 jmhbnz

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/

pgodfrin-nov avatar May 06 '24 11:05 pgodfrin-nov

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

Shubhdeep02 avatar Jun 21 '24 19:06 Shubhdeep02

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

Awesome - thanks!

/assign @Shubhdeep02

jmhbnz avatar Jun 21 '24 21:06 jmhbnz

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

Shubhdeep02 avatar Jun 22 '24 07:06 Shubhdeep02

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.

jmhbnz avatar Jun 22 '24 09:06 jmhbnz

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

Shubhdeep02 avatar Jun 24 '24 17:06 Shubhdeep02