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

[DOC-10949] Update Docker instructions for Cloud-first #18839

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

mdlinville
Copy link
Contributor

@mdlinville mdlinville commented Aug 19, 2024

[DOC-10949] Update Docker instructions for Cloud-first

  • Also externalize Docker instructions into a version-specific include
  • Also convert HTML to Markdown

This is related to #18826 but I separated it out on purpose so that I can rebase this one on that one's work.

Sending for initial review before backporting to more versions

Previews

src/current/v24.2/install-cockroachdb-mac.md
src/current/v24.2/install-cockroachdb-windows.md
src/current/v24.2/install-cockroachdb-linux.md

Copy link

netlify bot commented Aug 19, 2024

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 2dbcb11
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-interactivetutorials-docs/deploys/66c505f026f5750008855a0a

Copy link

netlify bot commented Aug 19, 2024

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 2dbcb11
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-api-docs/deploys/66c505f07e78fb0008682a06

Copy link

netlify bot commented Aug 19, 2024

Deploy Preview for cockroachdb-docs failed. Why did it fail? →

Name Link
🔨 Latest commit 78aba0e
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-docs/deploys/66c501e47e78fb0008359c0b

Copy link
Contributor

@rmloveland rmloveland left a comment

Choose a reason for hiding this comment

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

This LGTM

Suggest getting a cursory review from someone in #release-engineering so they're informed


Experimental images are not qualified for production use and not eligible for support or uptime SLA commitments.

1. Install a container runtime, such as [Docker Desktop](https://docs.docker.com/desktop/install/).
Copy link
Contributor

Choose a reason for hiding this comment

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

the link to Docker Desktop is 404ing

Screenshot 2024-08-20 at 11 15 30 AM


1. Install a container runtime, such as [Docker Desktop](https://docs.docker.com/desktop/install/).
1. Verify that the runtime service is installed correctly and running in the background. Refer to the runtime's documentation. For Docker, start a terminal and run `docker version`. If you get an error, verify your installation and try again.
1. Visit [Docker Hub](https://hub.docker.com/r/cockroachdb/cockroach) and decide which image tag to pull. CockroachDB images are published on [Docker Hub](https://hub.docker.com/r/cockroachdb/cockroach). Releases are rolled out gradually. Docker images for a new release are published when other binary artifacts are published. The following tag formats are commonly used, although other tags are available.
Copy link
Contributor

Choose a reason for hiding this comment

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

not strictly necessary to repeat the Docker Hub link IMO

<thead>
<tr>
<td>Tag</td>
<td>Example></td>
Copy link
Contributor

Choose a reason for hiding this comment

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

This renders as Example> with an unnecessary > after the word

<tr>
<td>`latest`</td>
<td>The latest patch within the latest major version.
<td>This is the default default if you do not specify a tag. It updates your cluster automatically to each new patch and major version, and is not recommended in production.</td>
Copy link
Contributor

Choose a reason for hiding this comment

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

doubled word: "default default"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants