Direct users to official Linux install instruction #19625
Conversation
... not bespoke `curl` commands that can break. Fixes DOC-13739
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
@taroface i took a shot at just pointing users to the official install instructions & getting rid of the bespoke |
|
@jhlodin adding you as an FYI since this is a 'deployment & ops' change |
|
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. |
|
+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. |
yes!
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! |
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 anyway PTAL and let me know what you think! |
| @@ -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`: | |||
There was a problem hiding this comment.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
Yes!
I saw Joe's comment that he was also in favor of this and I experimented with adding the Re: the overall PR, I just updated it so all the various things now funnel to the Linux install page as @jhlodin LGTM'd that approach in this comment PTAL - If you guys are happy with this, I will then backport it to other supported versions before merge However if you want additional changes, please let me know! Happy to fix anything needed |
... not bespoke
curlcommands that can break.Fixes DOC-13739