Added 'Getting started with etcdctl' page and also modified Quickstart page to link to the newly added page #476
Conversation
…t page to link to the newly added page
…t page to link to the newly added page
…t page to link to the newly added page
|
Thanks for this @Somoshree, it's a great start! I see that you're basing this page on the Interacting with etcd page, I think that's a good idea, but remember the goals of that page and a getting started page are different. A getting started page should show a reader enough to get a simple example system up and running, and link out to other pages for more detail or advanced setup. In our case, etcd.io may not have the content for these advanced detail links - if that's the case, it's OK to link to the etcd-io/etcd repo that @spzala shared. If we do go that route, we'll want to open another issue to ensure that we eventually bring the https://github.com/etcd-io/etcd/tree/main/etcdutl content into the main documentation repo (here), but doing any more than linking to it in this PR is probably out of scope for creating a getting started page. Also note, if you're taking content out of the Interacting with etcd page to bring it into the getting started page, we'll want to make sure it's removed from that page so the content isn't duplicated. That page may be need to be edited and reworked a bit in the context of having a new getting started guide. Here are some Getting Started pages that I think are good examples: |
|
These are some good changes @Somoshree. The shorter page with more direct instructions is good, but be careful that we're not duplicating content from other pages directly. The other thing to look at, from the issue, is:
@spzala is there a good source to reference for authenticating to existing clusters with Also, it may be difficult to include authentication to existing clusters unless we in the earlier instructions set up a cluster to authenticate to, or perhaps we can set up a docker container somewhere to help stream line the process. |
There was a problem hiding this comment.
Suggest to remove lines from 8 to 16. We don't need them here.
Also, remove lines 17 to 23, and add something like "etcdctl is shipped with etcd release binaries. On a running etcd cluster, find out the version of etcdctl by running the following command..." Thanks!
|
@nate-double-u here, https://github.com/etcd-io/etcd/tree/main/etcdctl#auth-enable-or-disable |
|
In a meeting earlier today with @Somoshree & @spzala, we discussed potentially updating the Quickstart page with information about authentication to existing clusters, rather than creating a new page here as a lot of the content is a duplication of sorts. Potentially we don't need a separate "Getting Started with |
|
Closing as per conversation with @Somoshree & @jberkus |
closes: #394
Deploy previews: