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

cli: update docs url for sql shell #118960

Merged
merged 1 commit into from Feb 8, 2024

Conversation

lunevalex
Copy link
Collaborator

@lunevalex lunevalex commented Feb 8, 2024

The SQL shell help function redirects the user to
use-the-built-in-sql-client.html this page no longer exists. Instead the SQL shell should point to cockroach-sql.html.

Epic: None

Release note (cli change): Change the SQL shell help URL to point to cockroach-sql.html.

Copy link

blathers-crl bot commented Feb 8, 2024

It looks like your PR touches production code but doesn't add or edit any test code. Did you consider adding tests to your PR?

🦉 Hoot! I am a Blathers, a bot for CockroachDB. My owner is dev-inf.

@cockroach-teamcity
Copy link
Member

This change is Reviewable

@lunevalex lunevalex marked this pull request as ready for review February 8, 2024 18:48
@lunevalex lunevalex requested review from a team as code owners February 8, 2024 18:48
The SQL shell help function redirects the user to
use-the-built-in-sql-client.html this page no longer exists.
Instead the SQL shell should point to cockroach-sql.html.

Epic: None

Release note (cli change): Change the SQL shell help URL
to point to cockroach-sql.html.
@@ -276,7 +276,7 @@ func (c *cliState) printCliHelp() {
fmt.Fprintf(c.iCtx.stdout, helpMessageFmt,
demoHelpStr,
docs.URL("sql-statements.html"),
docs.URL("use-the-built-in-sql-client.html"),
docs.URL("cockroach-sql.html"),
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not for this PR, but the link without the extension is preferred. The website automatically redirects from the page with .html to the one without.

mdlinville added a commit to cockroachdb/docs that referenced this pull request Feb 8, 2024
* Extend redirect to more versions

This link is used in the CLI help text. This redirect will be needed until the help text is updated in cockroachdb/cockroach#118960.
Copy link
Collaborator

@rafiss rafiss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm! the test failures all are unrelated

@lunevalex
Copy link
Collaborator Author

TFTR!

bors r+

@lunevalex lunevalex added backport-23.2.x Flags PRs that need to be backported to 23.2. backport-23.1.x Flags PRs that need to be backported to 23.1 labels Feb 8, 2024
@mdlinville
Copy link
Collaborator

Since you are already backporting to 23.1, would you consider backporting to 22.2 in case we cut another release?

@craig
Copy link
Contributor

craig bot commented Feb 8, 2024

Build succeeded:

@craig craig bot merged commit 3671865 into cockroachdb:master Feb 8, 2024
7 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-23.1.x Flags PRs that need to be backported to 23.1 backport-23.2.x Flags PRs that need to be backported to 23.2.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants