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

Add etcdutl documentation #309

Open
nate-double-u opened this issue May 22, 2021 · 7 comments
Open

Add etcdutl documentation #309

nate-double-u opened this issue May 22, 2021 · 7 comments
Assignees
Labels
e1-hours Effort: < 8 hrs e2-days Effort: < 5 days enhancement New feature or request help wanted Extra attention is needed p1-high p2-medium v3.5

Comments

@nate-double-u
Copy link
Contributor

nate-double-u commented May 22, 2021

@ptabor Should we add etcdutl as well? (newly introduced in 3.5)

Originally posted by @gyuho in #288 (comment)

Potentially we could potentially add it to content/en/docs/next/dl-build.md, and/or we may want to create a new page for it.

@chalin
Copy link
Contributor

chalin commented May 22, 2021

Isn't it named etcdutl?

@nate-double-u nate-double-u added enhancement New feature or request v3.5 labels May 22, 2021
@chalin
Copy link
Contributor

chalin commented May 22, 2021

Ah, yes: https://github.com/etcd-io/etcd/tree/main/etcdutl

@nate-double-u nate-double-u changed the title Add etcdutil documentation Add etcdutl documentation May 22, 2021
@nate-double-u
Copy link
Contributor Author

Good catch, thanks for the correction!

@spzala
Copy link
Member

spzala commented Sep 9, 2021

Sharing per today's meeting discussion - https://github.com/etcd-io/etcd/tree/main/etcdutl

@nate-double-u
Copy link
Contributor Author

/cc @Somoshree

@Somoshree
Copy link
Contributor

/assign

@chalin
Copy link
Contributor

chalin commented Sep 23, 2021

For consistency, with the current site content I believe that a bullet for etcdutl should be added to Library and tools > Tools.

Oh! Now I see where the content of #478 comes from: it is from etcd/main/etcdutl/README.md.

IMHO, if we chose to add the content of https://github.com/etcd-io/etcd/tree/main/etcdutl to the website, then:

  1. We should remove the content from etcd/main/etcdutl/README.md, and instead refer the reader to content on the website -- which could be under /docs/v3.5/integrations/etcdutl (See Note below.). In my opinion, this would be a good move, but it should probably be discussed at the community meeting.
  2. If we do this for etcdutl then we should do it for all the tools.

Note: might some IA rework needed? Maybe /docs/v3.5/integrations/ should be split into the following (IMHO) more intuitive names especially if we bring in subpages:

  • /docs/v3.5/tools
  • /docs/v3.5/libraries.
    Come to think of it, it would actually make more sense to use /docs/v3.5/languages -- maybe it could be made similar to grpc.io/docs/languages? Then pages like Golang modules could be placed under /docs/v3.5/languages/go.

Thoughts?

@chalin chalin mentioned this issue Sep 23, 2021
42 tasks
@jberkus jberkus added the help wanted Extra attention is needed label Nov 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
e1-hours Effort: < 8 hrs e2-days Effort: < 5 days enhancement New feature or request help wanted Extra attention is needed p1-high p2-medium v3.5
Projects
None yet
5 participants