Simplify CI/CD documentation structure #55
Merged
Conversation
This file contains hidden or 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
Replace GitHub Actions and GitLab CI/CD components with the new recce-cloud CLI for simpler, more direct CI/CD integration. Changes: - Replace DataRecce/recce-cloud-cicd-action with recce-cloud upload command - Replace GitLab component with direct CLI usage - Remove RECCE_API_TOKEN requirements (auto-detects GITHUB_TOKEN/CI_JOB_TOKEN) - Simplify authentication - no manual token setup needed - Add platform-specific verification images for GitHub/GitLab CI/CD - Update configuration examples to show CLI flags instead of component inputs Benefits: - Simpler setup without external dependencies - Consistent approach across GitHub and GitLab - Automatic platform and context detection - Direct pip install + CLI execution 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: even-wei <evenwei@infuseai.io>
Remove unused generic setup-ci.md and setup-cd.md files that have been replaced by platform-specific documentation in github/ and gitlab/ subdirectories. Files removed: - docs/7-cicd/setup-ci.md (replaced by github/setup-ci.md and gitlab/setup-ci.md) - docs/7-cicd/setup-cd.md (replaced by github/setup-cd.md and gitlab/setup-cd.md) - docs/assets/images/7-cicd/verify-setup-ci.png (replaced by platform-specific images) - docs/assets/images/7-cicd/verify-setup-cd.png (replaced by platform-specific images) These files were not referenced in mkdocs.yml navigation and contained outdated GitHub Action-based workflows that have been superseded by the new recce-cloud CLI approach. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: even-wei <evenwei@infuseai.io>
Standardize capitalization across documentation: - Github -> GitHub - Gitlab -> GitLab Updated files: - docs/7-cicd/ci-cd-getting-started.md - docs/2-getting-started/start-free-with-cloud.md 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: even-wei <evenwei@infuseai.io>
Add real-world CLI output examples to help users verify their CI/CD setup is working correctly. Shows the detailed output from recce-cloud upload command including: - CI environment detection (platform, PR/MR number, branches, etc.) - Authentication method used (GITHUB_TOKEN/CI_JOB_TOKEN) - Session creation and artifact upload progress - Success confirmation with session ID and URLs Examples added to: - GitHub CI setup (PR validation) - GitHub CD setup (production baseline) - GitLab CI setup (MR validation) - GitLab CD setup (production baseline) These examples help users: - Confirm their setup is working correctly - Understand what information is automatically detected - Verify authentication is working - Get session IDs and URLs for reviewing changes 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: even-wei <evenwei@infuseai.io>
Unify GitHub and GitLab CI/CD setup guides into platform-agnostic documentation with side-by-side comparisons, reducing documentation by ~90% while improving clarity and maintainability. Changes: - Merge platform-specific guides into unified setup-cd.md and setup-ci.md - Add line numbers and syntax highlighting to all YAML examples - Add verification screenshots for both GitHub and GitLab - Move troubleshooting to Setup CD (logical first step) - Relocate GitLab PAT guide to getting-started (accessible via links only) - Update all cross-references and navigation structure Benefits: - 50% reduction in CI/CD documentation files (9 files → 2 files) - Equal platform treatment with comparison tables - Single source of truth for both platforms - Easier maintenance and consistency 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: even-wei <evenwei@infuseai.io>
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.
Summary
Unified GitHub and GitLab CI/CD setup guides into platform-agnostic documentation, reducing files by 90% while improving clarity and maintainability.
Key Changes
Documentation Structure:
setup-cd.md,setup-ci.md)getting-started/(accessible via contextual links)Enhanced Code Examples:
linenums="1")recce-cloud upload)Improved Verification:
Better Troubleshooting:
Files Changed
Deleted (7 files):
docs/7-cicd/github/setup-cd.mddocs/7-cicd/github/setup-ci.mddocs/7-cicd/github/scenario-ci.mddocs/7-cicd/gitlab/setup-cd.mddocs/7-cicd/gitlab/setup-ci.mddocs/7-cicd/gitlab/gitlab-pat-guide.mddocs/7-cicd/gitlab-pat-guide.mdCreated (2 files):
docs/7-cicd/setup-cd.md(unified)docs/7-cicd/setup-ci.md(unified)Moved (1 file):
docs/2-getting-started/gitlab-pat-guide.md(from CI/CD section)Benefits
Testing Checklist
🤖 Generated with Claude Code