Skip to content

Conversation

@ebenezerdon
Copy link
Contributor

@ebenezerdon ebenezerdon commented Nov 3, 2025

What does this PR do?

Documents Sites deployment environments, guidelines and strategies for managing multiple environments

Test Plan

  • /docs/products/sites/deployments#deployment-environments

Related PRs and Issues

DRL-1793

Summary by CodeRabbit

  • Documentation
    • Expanded deployment environments section with details on managing multiple sites per environment, configuring per-site environment variables, and implementing branch deployments.

@ebenezerdon ebenezerdon self-assigned this Nov 3, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 3, 2025

Walkthrough

This 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

  • Verify the new documentation content is accurate and consistent with the product's deployment architecture
  • Confirm Markdoc syntax is properly formatted (tag closure, spacing)
  • Check that the new section integrates logically with existing deployment documentation

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: documentation for Sites deployment environments, which aligns with the PR's objective to document deployment environment management and strategies.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/sites-deployment-environments

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

📥 Commits

Reviewing files that changed from the base of the PR and between 8a910e0 and e8263ab.

📒 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.

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