Direct users to official Linux install instruction #19625
Conversation
✅ 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! |
src/current/_includes/v25.2/prod-deployment/insecure-test-load-balancing.md
Outdated
Show resolved
Hide resolved
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 |
| <div class="highlight"><pre><code class="language-shell" data-lang="shell"><span class="nb">cp </span>-i cockroach-{{ page.release_info.version }}.linux-{ARCHITECTURE}/lib/libgeos.so /usr/local/lib/cockroach/</code></pre></div> | ||
| <div class="highlight"><pre><code class="language-shell" data-lang="shell"><span class="nb">cp </span>-i cockroach-{VERSION}.linux-{ARCHITECTURE}/lib/libgeos.so /usr/local/lib/cockroach/</code></pre></div> |
There was a problem hiding this comment.
Was the liquid var not rendering appropriately here? I think we would at least need an example of how to properly express the version in the path. The current published version also has here:
In the following commands, replace {ARCHITECTURE} with linux-amd64 for Intel, or with linux-arm64 for ARM.
which seems useful to know. This comment applies to all similar blocks.
There was a problem hiding this comment.
Was the liquid var not rendering appropriately here?
Unfortunately it gives incorrect information for several weeks a year during the cloud-first release periods, which was what prompted the user to report to us that curl commands in those other instructions were 404ing. I updated it to {VERSION} to follow the same existing pattern as {ARCHITECTURE} since we already have that, and due to the use of {ARCHITECTURE} the URLs on this page were already not "curlable" and had to be edited.
I think we would at least need an example of how to properly express the version in the path
You're right! Made a wrong assumption there. I have updated the page in both places where this is used with the line:
In the following commands, replace
{VERSION}with the version of CockroachDB you are installing, and replace{ARCHITECTURE}withlinux-amd64for Intel, or withlinux-arm64for ARM.
The change is in 19116f6
|
Thanks for the reviews @taroface and @jhlodin ! I'm going to squash and then rebase onto |
rmloveland
force-pushed
the
20250521-DOC-13739-no-custom-curl-downloads
branch
from
19116f6 to
80fa888
Compare
... not bespoke `curl` commands that can break. NB. These changes are backported to supported versions v24.1+ Fixes DOC-13739
rmloveland
force-pushed
the
20250521-DOC-13739-no-custom-curl-downloads
branch
from
80fa888 to
79cf289
Compare
... not bespoke
curlcommands that can break.Fixes DOC-13739