-
Notifications
You must be signed in to change notification settings - Fork 284
Document Sites deployment environments #2563
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
…aging production, staging, and development sites
WalkthroughThis pull request modifies a Markdoc documentation file to expand the Deployment environments section. The change restructures the closing of an existing info tag and adds a new content block that describes deployment environment management, including topics such as multiple sites per environment, per-site environment variables, and branch deployments. No existing logic or code is altered. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Pre-merge checks and finishing touches✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
src/routes/docs/products/sites/deployments/+page.markdoc (1)
108-118: Consider clarifying the automatic nature of branch deployments.The statement "Every branch in a site has a dedicated deployment" (Line 110) might be unclear. It could be interpreted as every branch automatically getting a deployment, when the actual behavior is that Appwrite creates preview deployments automatically for pull requests.
Consider revising to make the automatic behavior more explicit and distinguish it from the manual site-per-environment setup discussed earlier.
For example:
## Branch deployments -Every branch in a site has a dedicated deployment. Once your pull request is up, Appwrite creates a preview deployment so you can test and review changes before merging. Learn more in [Previews](/docs/products/sites/previews). +Appwrite automatically creates preview deployments for pull requests. Once your pull request is created, Appwrite generates a dedicated deployment so you can test and review changes before merging. Learn more in [Previews](/docs/products/sites/previews).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/routes/docs/products/sites/deployments/+page.markdoc(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-09-24T08:55:57.959Z
Learnt from: amustaque97
Repo: appwrite/website PR: 2434
File: deploy/templates/deployment.yaml:0-0
Timestamp: 2025-09-24T08:55:57.959Z
Learning: In the Appwrite website Helm deployment, environment variables are managed through ConfigMap rather than direct Helm values injection, so security concerns about secrets in Deployment manifests don't apply to their setup.
Applied to files:
src/routes/docs/products/sites/deployments/+page.markdoc
📚 Learning: 2025-09-24T09:16:03.075Z
Learnt from: amustaque97
Repo: appwrite/website PR: 2434
File: .github/workflows/staging.yml:117-131
Timestamp: 2025-09-24T09:16:03.075Z
Learning: In the Appwrite website deployment, environment variables are baked into the Docker image during the build stage using build-args, so creating a separate ConfigMap in the Kubernetes deployment job is unnecessary and redundant.
Applied to files:
src/routes/docs/products/sites/deployments/+page.markdoc
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: build
- GitHub Check: tests
🔇 Additional comments (2)
src/routes/docs/products/sites/deployments/+page.markdoc (2)
85-86: LGTM!The formatting change properly separates the info block from the new section.
93-93: All referenced documentation pages exist and are valid. No issues were found.
What does this PR do?
Documents Sites deployment environments, guidelines and strategies for managing multiple environments
Test Plan
/docs/products/sites/deployments#deployment-environmentsRelated PRs and Issues
DRL-1793
Summary by CodeRabbit