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.

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

Use common includes for orchestration pages #18894

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

Use common includes for orchestration pages #18894

wants to merge 11 commits into from

Conversation

mdlinville
Copy link
Contributor

@mdlinville mdlinville commented Sep 11, 2024 •
edited
Loading

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:

  • Moves images/v24.2/kubernetes*.png to images/common/
  • Moves _includes/v24.2/orchesteration/ to _includes/common/orchestration
  • Updates includes within _includes/common/orchestration to point to the common content for their own includes and to use the common images.
    • No includes other than orchestration includes are called within _includes/v24.2 and no other v24.2 pages use the common images.
  • Updates pages within v24.2/ to point to the common content for orchestration includes and images.
  • Tweak the cockroachcloud/use-cloud-instead.md include to use a Markdown link.
  • Where an include I review or modify contains no Liquid, update related include statements to include_cached.
  • Backports the above to v24.1, v23.2, v23.1, v22.2

Tests:

  • Local build
  • Local linkcheck

@github-actions GitHub Actions
Copy link

github-actions bot commented Sep 11, 2024 •
edited
Loading

Files changed:

@netlify Netlify
Copy link

netlify bot commented Sep 11, 2024 •
edited
Loading

✅ Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit d616ec3
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-api-docs/deploys/67096b7ef4fef50008ada994

@netlify Netlify
Copy link

netlify bot commented Sep 11, 2024 •
edited
Loading

✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit d616ec3
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-interactivetutorials-docs/deploys/67096b7ee57a2e000869add4

@netlify Netlify
Copy link

netlify bot commented Sep 11, 2024 •
edited
Loading

✅ Netlify Preview

Name Link
🔨 Latest commit d616ec3
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-docs/deploys/67096b7e89cee200087eac97
😎 Deploy Preview https://deploy-preview-18894--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 site configuration.

@mdlinville mdlinville changed the title [POC] Use common includes for v24.2 orchestration pages [POC] Use common includes for v24.2 and v24.1 orchestration pages Sep 27, 2024
@mdlinville mdlinville force-pushed the k8s_common_includes branch 4 times, most recently from 428b2ee to 60327b5 Compare September 30, 2024 18:16
@mdlinville mdlinville changed the title [POC] Use common includes for v24.2 and v24.1 orchestration pages Use common includes for orchestration pages Sep 30, 2024
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

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

Successfully merging this pull request may close these issues.
1 participant
@mdlinville