Use common includes for orchestration pages #18894
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Files changed:
|
✅ 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 site configuration. |
mdlinville
force-pushed
the
k8s_common_includes
branch
from
1711359
to
52a695e
Compare
mdlinville
changed the title
mdlinville
force-pushed
the
k8s_common_includes
branch
4 times, most recently
from
428b2ee
to
60327b5
Compare
mdlinville
force-pushed
the
k8s_common_includes
branch
from
60327b5
to
194c07c
Compare
mdlinville
changed the title
mdlinville
force-pushed
the
k8s_common_includes
branch
from
194c07c
to
ac733a6
Compare
taroface
requested changes
Oct 15, 2024
| @@ -1,3 +1,3 @@ | |||
| {{site.data.alerts.callout_success}} | |||
| To deploy a free CockroachDB {{ site.data.products.cloud }} cluster instead of running CockroachDB yourself, see the <a href="{% link cockroachcloud/quickstart.md %}">Quickstart</a>. | |||
| To deploy a free CockroachDB Cloud cluster instead of running CockroachDB yourself, see the [Quickstart]({% link cockroachcloud/quickstart.md %}). | |||
There was a problem hiding this comment.
Is there a reason the product variable was removed for Cloud?
| ~~~ | ||
| 1. Create a `my-values.yaml` file to override the defaults in `values.yaml`, substituting your own values in this example based on the guidelines below. | ||
|
|
||
| {% include_cached copy-clipboard.html %} |
There was a problem hiding this comment.
This needs one more level of indentation. See in preview: https://deploy-preview-18894--cockroachdb-docs.netlify.app/docs/v22.2/deploy-cockroachdb-with-kubernetes-insecure.html?filters=helm
|
|
||
| 1. Use the file to create the StatefulSet and start the cluster: | ||
| Modify the file wherever there is a `TODO` comment, then use the file to create the StatefulSet and start the cluster: |
There was a problem hiding this comment.
This needs the 1. back. It's breaking the list and the snippet below. See: https://deploy-preview-18894--cockroachdb-docs.netlify.app/docs/v22.2/deploy-cockroachdb-with-kubernetes-insecure.html?
| <section class="filter-content" markdown="1" data-scope="operator"> | ||
|
|
||
| {% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} | ||
|
|
||
| 1. To use the CockroachDB SQL client, first launch a secure pod running the `cockroach` binary. | ||
| 1. From your local workstation, use the [Kubernetes Operator](https://github.com/cockroachdb/cockroach-operator/) file to launch a pod and keep it running indefinitely. | ||
|
|
||
| {% include_cached copy-clipboard.html %} | ||
| ~~~ shell | ||
| $ kubectl create \ | ||
| -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/client-secure-operator.yaml |
There was a problem hiding this comment.
This is pointing to a secure yaml, though. Do we have an insecure one for the Operator? Maybe this is why we never added an Operator option for the local insecure doc.
There was a problem hiding this comment.
This was incorrectly renamed to test-cluster-insecure rather than test-cluster-secure. So it's being included on the wrong doc.
There was a problem hiding this comment.
This looks like the wrong content? Should be Cluster Upgrades.
There was a problem hiding this comment.
Same comment as earlier; this is the wrong file content.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Within each major version, a series of pages about Kubernetes is driven by a series of includes about Kubernetes. Kubernetes itself is CRDB-version-agnostic. Rather than moving the content pages around, this PR shares the common includes related to Kubernetes among major version docs. This will ease maintenance of this content, and may also improve site build times by reducing the # of files being built.
This PR:
images/v24.2/kubernetes*.pngtoimages/common/_includes/v24.2/orchesteration/to_includes/common/orchestration_includes/common/orchestrationto point to the common content for their own includes and to use the common images._includes/v24.2and no other v24.2 pages use the common images.v24.2/to point to the common content for orchestration includes and images.cockroachcloud/use-cloud-instead.mdinclude to use a Markdown link.includestatements toinclude_cached.Tests: