Skip to content

Direct users to official Linux install instruction #19625

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Direct users to official Linux install instruction #19625

wants to merge 2 commits into from

Conversation

rmloveland
Copy link
Contributor

... not bespoke curl commands that can break.

Fixes DOC-13739

@rmloveland
Direct users to official Linux install instruction
f42ceb1 
... not bespoke `curl` commands that can break.

Fixes DOC-13739
@netlify Netlify
Copy link

netlify bot commented May 21, 2025 •
edited
Loading

✅ Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit a22b9f6
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-api-docs/deploys/683777480cdef60008adb613

@netlify Netlify
Copy link

netlify bot commented May 21, 2025 •
edited
Loading

✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit a22b9f6
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-interactivetutorials-docs/deploys/683777439de86200085452e6

@github-actions GitHub Actions
Copy link

github-actions bot commented May 21, 2025 •
edited
Loading

Files changed:

@netlify Netlify
Copy link

netlify bot commented May 21, 2025 •
edited
Loading

✅ Netlify Preview

Name Link
🔨 Latest commit a22b9f6
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/683777436399dd0008a93e91
😎 Deploy Preview https://deploy-preview-19625--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@rmloveland rmloveland requested a review from taroface May 21, 2025 20:06
@rmloveland
Copy link
Contributor Author

@taroface i took a shot at just pointing users to the official install instructions & getting rid of the bespoke curl commands. PTAL! Once we get something we're happy with, I'll backport it to our other supported versions v23.1+

@rmloveland rmloveland requested a review from jhlodin May 21, 2025 20:08
@rmloveland
Copy link
Contributor Author

@jhlodin adding you as an FYI since this is a 'deployment & ops' change

@taroface
Copy link
Contributor

To be clear, the intent is to link people to the doc that takes them down a more regularly maintained flow to find the binaries they want, right?

If so, it looks like the Install Linux page links out to the CockroachDB Releases page, and you kinda have to dig for a moment to find this. Would it be friendlier to just link directly to that section (substituting the page version)? eg, https://www.cockroachlabs.com/docs/releases?#v25-2

I don't feel strongly about this but wondering what you and @jhlodin think.

@jhlodin
Copy link
Contributor

jhlodin commented May 22, 2025

+1 to what Ryan said, but also the new target page doesn't actually have any instructions for downloading, extracting, and adding the binary to the PATH. In other words, this now sends people off to another page to be told to run commands that were on the original page.

I think the general idea of updating these snippets to point to the Linux install doc is on-point, but the common download/extract/copy code blocks need to move to the install doc.

@rmloveland
Copy link
Contributor Author

To be clear, the intent is to link people to the doc that takes them down a more regularly maintained flow to find the binaries they want, right?

yes!

If so, it looks like the Install Linux page links out to the CockroachDB Releases page, and you kinda have to dig for a moment to find this. Would it be friendlier to just link directly to that section (substituting the page version)? eg, https://www.cockroachlabs.com/docs/releases?#v25-2

I don't feel strongly about this but wondering what you and @jhlodin think.

i ended up going with a variant of what Joe suggested, update the Linux install page with all the instructions and then link everything to that. PTAL and let me know what you think!

@rmloveland
Copy link
Contributor Author

+1 to what Ryan said, but also the new target page doesn't actually have any instructions for downloading, extracting, and adding the binary to the PATH. In other words, this now sends people off to another page to be told to run commands that were on the original page.

I think the general idea of updating these snippets to point to the Linux install doc is on-point, but the common download/extract/copy code blocks need to move to the install doc.

makes sense, i updated the Linux install page to have all the download/extract/install instructions there, and pointed everything else to that page

i also updated the way we reference VERSION and ARCHITECTURE on that page in a few places because even though it's nice we can refer to specific versions using the {{page.version.version}} Liquid tag, it is wrong sometimes (e.g. due to the reason that led to this PR), and we were also (incorrectly IMO) assuming the world is on x86_64 which is increasingly not true. I don't think it's a huge lift for users to know their own version/arch combo

anyway PTAL and let me know what you think!

rmloveland
rmloveland commented May 28, 2025
View reviewed changes
src/current/_includes/v25.2/prod-deployment/insecure-test-load-balancing.md
@@ -12,12 +12,11 @@ For comprehensive guidance on benchmarking CockroachDB with TPC-C, see [Performa

This should be a machine that is not running a CockroachDB node.

1. Download the [CockroachDB archive](https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz) for Linux, and extract the binary:
1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

ah sorry i missed a couple of spots. @taroface and @jhlodin pls let me know what you think of the approach shown in the other files of linking everything to 'Install CockroachDB on Linux' and if you are on board I'll go through and update all of these usages as well

Copy link
Contributor

Choose a reason for hiding this comment

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

This approach LGTM. Side note, why is the Install CockroachDB on Linux page in raw HTML rather than markdown? Makes it much harder to read for review purposes.

Copy link
Contributor Author

@rmloveland rmloveland Jun 2, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

awesome thanks @jhlodin ! I will update everything in this PR to use that approach

re: why HTML, from memory it was because we were sprinkling the downloads page with various data-eventcategory and data-eventaction attributes that (at least at one time) were AIUI being consumed by Marketing to count downloads, etc. I do not know if that is true any longer tho

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@taroface taroface Awaiting requested review from taroface

@jhlodin jhlodin Awaiting requested review from jhlodin

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rmloveland @taroface @jhlodin