Skip to content

Conversation

@JakeSCahill
Copy link
Contributor

@JakeSCahill JakeSCahill commented Mar 21, 2025

Description

Partially resolves https://redpandadata.atlassian.net/browse/DOC-731 (handles the changes required for v2.4.x)
Review deadline: March 25

Related PR: redpanda-data/redpanda-operator#548

This pull request includes significant updates to various GitHub workflow files to improve the automation of documentation generation and Kubernetes compatibility checks. The changes focus on enhancing the workflows for generating Kubernetes reference docs, removing redundant workflows, and updating deployment documentation.

Improvements to workflows:

  • .github/workflows/fetch-acceptance-tests.yml: Renamed the workflow to "Fetch and Save Kubernetes Acceptance Tests" and removed the reviewers section. [1] [2]
  • .github/workflows/generate-crd.yml: Added inputs for the workflow_dispatch event, steps to determine the operator tag and docs branch, and new steps for downloading and installing tools like helm-docs and pandoc. The workflow now includes steps to convert Markdown to AsciiDoc and modify the AsciiDoc format. [1] [2] [3]

Removal of redundant workflows:

Updates to deployment documentation:

Page previews

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@netlify
Copy link

netlify bot commented Mar 21, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 49ca68f
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-docs-preview/deploys/67dd2eae969d97000820d522
😎 Deploy Preview https://deploy-preview-1024--redpanda-docs-preview.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.

@JakeSCahill JakeSCahill requested review from chrisseto and removed request for chrisseto March 21, 2025 09:18
@JakeSCahill JakeSCahill marked this pull request as draft March 21, 2025 09:22
@JakeSCahill JakeSCahill changed the base branch from beta to DOC-970 March 21, 2025 13:06
@JakeSCahill JakeSCahill changed the base branch from DOC-970 to beta March 21, 2025 16:04
@JakeSCahill JakeSCahill changed the base branch from beta to DOC-970 March 21, 2025 16:04
@JakeSCahill JakeSCahill marked this pull request as ready for review March 21, 2025 16:08
@JakeSCahill JakeSCahill changed the title DOC-731 Update Kubernetes automations to work on tags in the RP Operator repo Update Kubernetes automations to work on tags in the RP Operator repo Mar 21, 2025
@JakeSCahill JakeSCahill requested a review from chrisseto March 21, 2025 17:18
Copy link
Contributor

@chrisseto chrisseto left a comment

Choose a reason for hiding this comment

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

All in all LGTM! Only blocker is the need to ignore non-operator releases/tags. We could probably push that filtering into the operator repo if you'd prefer?

@JakeSCahill JakeSCahill merged commit 96ab72e into DOC-970 Mar 25, 2025
4 of 8 checks passed
@JakeSCahill JakeSCahill deleted the DOC-731 branch March 25, 2025 11:02
JakeSCahill added a commit that referenced this pull request Mar 26, 2025
…#1024)

Co-authored-by: David Yu <yongshinyu@gmail.com>
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
Co-authored-by: Joyce Fee <joyce@redpanda.com>
JakeSCahill added a commit that referenced this pull request Apr 3, 2025
…#1024)

Co-authored-by: David Yu <yongshinyu@gmail.com>
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
Co-authored-by: Joyce Fee <joyce@redpanda.com>
JakeSCahill added a commit that referenced this pull request Apr 4, 2025
…#1024)

Co-authored-by: David Yu <yongshinyu@gmail.com>
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
Co-authored-by: Joyce Fee <joyce@redpanda.com>
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.

5 participants