[WIP]: docs: rewrite GitOps documentation - Overview and Get Started#1026
Open
[WIP]: docs: rewrite GitOps documentation - Overview and Get Started#1026
Conversation
Figma-style flowchart showing the 3-phase GitOps workflow: Develop (write SQL) → CI (PR triggers SQL review) → CD (merge triggers rollout to databases). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Main flow is now horizontal: Develop → CI → CD - Each phase shows Git on top, Bytebase below, Databases at bottom - Transition pills: "PR/MR created" and "PR/MR merged" - Database section shows Dev/Staging/Prod as individual instances - Wider spacing between columns for clear transition labels Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Replace text badges with actual GitHub octocat and Bytebase logos - Use PR only (remove MR references) since we focus on GitHub - Replace "Results posted to PR" box with dashed back-arrow labeled "post review" from Bytebase SQL Review to GitHub PR - Simplify to 2 databases: Test and Prod Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Overview page: - Diagram with compact CI phase (no whitespace) - Concise explanation of Database as Code workflow - "When to use GitOps" section with 4 bullet points - Next Steps linking to new Get Started page Also: - Add get-started.mdx placeholder page - Add get-started to docs.json navigation Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
4-step guide: authenticate (workload identity or service account), configure runners, add CI/CD workflow files, try first migration. Includes placeholder for upcoming GitOps landing page tool. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Step 1: Auth tabs for Workload Identity vs Service Account, with nested GitHub/GitLab tabs for secret configuration - Step 2: Runner guidance with GitHub/GitLab tabs and tables - Step 3: GitOps landing page as primary path, manual config in accordion. Placeholder for screenshot - Step 4: Platform-neutral steps with GitHub/GitLab tabs for screenshots and CI/CD navigation Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Lead with Workload Identity as the recommended path - Demote Service Account to a collapsed accordion - Simplify runner section to two bullet points - Step 3 assumes GitOps landing page, manual config in accordion - Tighter prose throughout, fewer substeps Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Get Started: - Step 1: Workload Identity with full substeps for GitHub/GitLab, Service Account as alternative for other VCS platforms - Step 2: Runner selection criteria (public vs private Bytebase), 5-10 line setup instructions per platform - Step 3: GitOps landing page as primary path with explanation, manual config in accordion with env variable reference - Step 4: Full migration walkthrough with file naming, push/PR instructions, review screenshots, and deploy verification per platform. TODO placeholders for release screenshots Diagram: - Rename "Create Rollout" to "Create Release" to match workflow file naming (release-action.yml) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Placeholder stubs for postgresql.mdx and spanner.mdx snippets that are missing from this worktree, needed for Mintlify dev server to start without import errors. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Step 1: Replace tabbed substeps with concise text + links for workload identity - Step 3: Remove intro paragraph, just instruct user to go to GitOps page - Step 4: Use create_table_t1 example from tutorials, conform naming - Step 4.3: Remove git commands, just give instructions - Step 4.4: Use correct SQL review screenshots from tutorials (gh/gl-sql-review-warning) - Step 4.6: Add deployment screenshots from tutorials (GH: 5.4/5.5/5.6, GL: 5.5/5.6) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
These were created as workarounds for missing worktree files but are not needed for the GitOps documentation. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
zchpeter
changed the title
zchpeter
changed the title
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
Test plan
mint devfromdocs/directory🤖 Generated with Claude Code