Misc 21.1.1 CLI updates #10805
Misc 21.1.1 CLI updates #10805
Conversation
|
This change is |
|
Files changed: _includes/v21.1/app/start-cockroachdb.md |
|
✔️ Netlify Preview 🔨 Explore the source changes: 7f979f1 🔍 Inspect the deploy log: https://app.netlify.com/sites/cockroachdb-docs/deploys/60dcae926327fa000843058a 😎 Browse the preview: https://deploy-preview-10805--cockroachdb-docs.netlify.app |
ericharmeling
force-pushed
the
21.1.1-cli-updates
branch
from
210433f to
037f366
Compare
There was a problem hiding this comment.
Reviewed 26 of 26 files at r1.
Reviewable status:complete! 0 of 0 LGTMs obtained (waiting on @ericharmeling)
|
TFTR @knz ! |
| @@ -1,8 +1,8 @@ | |||
| Flag | Description | |||
| -----|------------ | |||
| `--host` | The server host and port number to connect to. This can be the address of any node in the cluster. <br><br>**Env Variable:** `COCKROACH_HOST`<br>**Default:** `localhost:26257` | |||
| `--port`<br>`-p` | The server port to connect to. Note: The port number can also be specified via `--host`. <br><br>**Env Variable:** `COCKROACH_PORT`<br>**Default:** `26257` | |||
| `--user`<br>`-u` | The [SQL user](create-user.html) that will own the client session.<br><br>**Env Variable:** `COCKROACH_USER`<br>**Default:** `root` | |||
| `--port`<br><br>`-p` | The server port to connect to. Note: The port number can also be specified via `--host`. <br><br>**Env Variable:** `COCKROACH_PORT`<br>**Default:** `26257` | |||
There was a problem hiding this comment.
Why the extra line break? I think it looks good as-is on the live site. The meaning (that they're alternates/synonyms) is clear to me.
There was a problem hiding this comment.
Reviewable status:
_includes/v21.1/sql/connection-parameters.md, line 4 at r1 (raw file):
Previously, mikeCRL (Mike Lewis) wrote…
Why the extra line break? I think it looks good as-is on the live site. The meaning (that they're alternates/synonyms) is clear to me.
I noticed that a single line break makes the options difficult to parse if one of the options runs on to the next line (the formatting makes it look like there is an additional option). Having double spaces accommodates this case, but it looks a bit odd if just one or two of the columns with multiple options have the double line break. So I tried to update all of these to be consistent.
This could for sure be a style discussion for reference tables with multiple items with the same description.
ericharmeling
force-pushed
the
21.1.1-cli-updates
branch
from
037f366 to
7f979f1
Compare
Fixes #10661.
Fixes #10660.
Fixes #10659.
Fixes #10658.
Fixes #9142.
Fixes #9143.
Fixes #9131.
This PR includes changes to the CLI reference docs for
cockroach sqlandcockroach demo, and updates to examples affected by the changes linked in thecockroachPRs above.