Use doc-tools CLI for GitHub Actions

[JakeSCahill]

Description

Review deadline: 29 May

This pull request simplifies the workflows by replacing a custom script with a standardized tool (doc-tools) and removes the associated custom code. It also updates paths for generating documentation. Below are the key changes:

Workflow Updates

• Replaced the custom script fetch.js with npx doc-tools fetch in the fetch-acceptance-tests.yml and get-cloud-api-spec.yml workflows for fetching files, simplifying the dependency management and execution process. [1] [2]
• Updated the file path for the operator Helm chart in the generate-crd.yml workflow to reflect the new directory structure.

Codebase Cleanup

• Removed the fetch.js script and its dependencies (@octokit/rest, chalk, etc.) by deleting scripts/fetch-from-github/fetch.js, package.json, and package-lock.json, as they are no longer needed with the adoption of doc-tools. [1] [2] [3]

Page previews

Checks

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

[netlify]

✅ Deploy Preview for redpanda-docs-preview ready!

Name	Link
🔨 Latest commit	60063d9
🔍 Latest deploy log	https://app.netlify.com/projects/redpanda-docs-preview/deploys/6838158427fd6d0008efabe5
😎 Deploy Preview	https://deploy-preview-1138--redpanda-docs-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

This set of changes removes several custom Node.js and Bash scripts used for fetching versions, generating compatibility matrices, and installing dependencies. Instead, these functionalities are replaced by invoking equivalent commands from the doc-tools CLI via npx across workflow YAML files and test setup JSONs. The changes also update workflow steps to no longer change directories before running commands, and update file paths for documentation conversion. All related package.json files and scripts for fetching versions, generating matrices, and installing dependencies are deleted, consolidating these processes under the doc-tools CLI.

Sequence Diagram(s)

sequenceDiagram
    participant Workflow
    participant npx doc-tools
    participant GitHub API
    participant Local System

    Workflow->>npx doc-tools: Run fetch/get/install command
    npx doc-tools->>GitHub API: Fetch required data (versions/files)
    GitHub API-->>npx doc-tools: Return data
    npx doc-tools->>Local System: Save or process data
    npx doc-tools-->>Workflow: Command complete

Loading

Suggested reviewers

• asimms41

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.