Update docs for https://github.com/vitessio/vitess/pull/17442 #1912
Conversation
Signed-off-by: Matt Lord <[email protected]>
✅ Deploy Preview for vitess ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Signed-off-by: Matt Lord <[email protected]>
Signed-off-by: Matt Lord <[email protected]>
Signed-off-by: Matt Lord <[email protected]>
|
Do we list all net-new commands on the diff page? |
| @@ -2,8 +2,10 @@ | |||
| title: vtctl | |||
There was a problem hiding this comment.
Should we just replace this with vtctldclient?
There was a problem hiding this comment.
I'm not sure. We frame the concept of vtctl here as being the pairing of the client and server. I'd follow your lead here.
| @@ -2,8 +2,10 @@ | |||
| title: vtctl | |||
| --- | |||
|
|
|||
| **vtctl** is a command-line tool used to administer a Vitess cluster. It is available as both a standalone tool (`vtctl`) and client-server (`vtctldclient` in combination with `vtctld`). Using client-server is recommended, as it provides an additional layer of security when using the client remotely. | |||
| **vtctl** is a command-line tool, `vtctldclient`, that is used as both a standalone tool (`vtctldclient --server=internal`) and client-server (`vtctldclient` in combination with `vtctld`) to administer a Vitess cluster. Using client-server is recommended, as it provides an additional layer of security when using the client remotely. | |||
There was a problem hiding this comment.
Same here. We can probably get rid of vtctl terminology now.
There was a problem hiding this comment.
Here it definitely seems off. In your mind, is vtctl a binary (same name) and a concept (client and server binaries)? If it's really just the former then we should definitely remove usage of it. My reading of the page was that it's a concept that spans the client and server pieces but maybe I just misread it.
Preview links: