Skip to content

Conversation

@joshrotenberg
Copy link
Collaborator

@joshrotenberg joshrotenberg commented Dec 16, 2025

Summary

Adds automatic documentation deployment to redis-field-engineering/redisctl-docs since redis-developer GitHub Pages redirects to redis.io.

Changes

Adds a deploy job to the docs workflow that:

  • Runs only on push to main (not PRs)
  • Builds mdBook documentation
  • Pushes built HTML to redis-field-engineering/redisctl-docs gh-pages branch
  • Uses DOCS_DEPLOY_TOKEN secret for cross-org repository access

Setup Required

  • Create redis-field-engineering/redisctl-docs repo
  • Add DOCS_DEPLOY_TOKEN secret to redis-developer/redisctl
  • Enable GitHub Pages on redis-field-engineering/redisctl-docs (Settings → Pages → gh-pages branch)

Result

Documentation will be available at:
https://redis-field-engineering.github.io/redisctl-docs/

Test plan

  • Merge this PR
  • Verify docs workflow runs and deploys successfully
  • Verify docs are accessible at the new URL

…sctl-docs

Adds a deploy job to the docs workflow that:
- Builds mdBook documentation on push to main
- Pushes built HTML to redis-field-engineering/redisctl-docs gh-pages branch
- Uses DOCS_DEPLOY_TOKEN for cross-org repository access

Documentation will be available at:
https://redis-field-engineering.github.io/redisctl-docs/

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@joshrotenberg joshrotenberg merged commit 95755df into main Dec 16, 2025
21 checks passed
@joshrotenberg joshrotenberg deleted the feat/docs-deploy branch December 16, 2025 22:22
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