Docs/terraform provider by eldadfux · Pull Request #2874 · appwrite/website

eldadfux · 2026-04-09T05:53:08Z

What does this PR do?

(Provide a description of what this PR does.)

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work.)

Related PRs and Issues

(If this PR is related to any other PR or resolves any issue or related to any issue link all related PR and issues here.)

Have you read the Contributing Guidelines on issues?

(Write your answer here.)

Add overview with Terraform basics, self-hosting redirect note, and guides for provider configuration, database resources, and data sources. Link to appwrite/terraform-provider-appwrite; align content with README. Made-with: Cursor

Made-with: Cursor

… nav Align docs with provider: bucket, messaging_provider, messaging_topic. Move database guide under resources/databases; add resources/storage and resources/messaging. Nav: Getting started, Resources, Data sources. Redirect old /terraform/databases path. Made-with: Cursor

Made-with: Cursor

…tion Made-with: Cursor

Made-with: Cursor

Add terraform.svg to icon pipeline (svgtofont + sprite), use web-icon-terraform in docs Tooling menu. Colors normalized by optimizer; sidebar uses currentColor like other nav icons. Made-with: Cursor

Made-with: Cursor

…th registry docs Add registry URLs for provider index, generated docs, and per-resource pages. Pin required_providers example to ~> 0.0.4; cross-link GitHub for source. Made-with: Cursor

…only Made-with: Cursor

Made-with: Cursor

…hyphens Made-with: Cursor

…e heading Made-with: Cursor

Add 2026-04-08 changelog on IaC value, docs, registry, and catalog. Add integrations/terraform-provider page under Deployments with cover and avatar SVGs. Made-with: Cursor

Product announcement with docs, registry, and integrations links; cover SVG. Made-with: Cursor

…weaks Add introducing-terraform-provider-for-appwrite post and levi-van-noort author. Use ASCII hyphens in Terraform provider and databases docs. Include icon font output assets and avatar. Made-with: Cursor

These copies are not produced by the icon build; drop them from the repo. Made-with: Cursor

Prevents accidental commits of Finder "file 2.ext" duplicates. Made-with: Cursor

Made-with: Cursor

greptile-apps · 2026-04-09T06:03:05Z

Greptile Summary

This PR adds the official Terraform provider documentation for Appwrite, including an overview page, provider configuration guide, eight resource pages (databases, storage, auth, functions, sites, messaging, webhooks, backups), a sidebar entry with a new Terraform icon, an integrations catalog page, a blog post, and a changelog entry. All previously flagged concerns — the 'mongo' removal from IconType, the broken changelog link, and the redirect chain issues — appear to have been fully resolved in the current HEAD: 'mongo' is present at line 15 of types.ts, the blog post and changelog both use the 2026-04-19 slug which matches the 2026-04-19.markdoc filename, and no broken redirect chains remain.

Confidence Score: 5/5

Safe to merge — all prior P0/P1 findings from earlier review rounds have been addressed in the current HEAD.

All previously flagged blocking issues are resolved: 'mongo' is retained in IconType, the changelog slug and filename are consistent (2026-04-19), and no broken redirect chains exist. Remaining notes (HCL→ini highlighting, FCM .gitignore guidance) were already flagged in prior review rounds and are P2 quality concerns that don't block merge.

No files require special attention.

Important Files Changed

Filename	Overview
src/lib/components/ui/icon/types.ts	Adds 'terraform' to the IconType union; existing entries including 'mongo' are preserved
src/lib/components/ui/icon/sprite/sprite.svelte	Adds SVG sprite; inserted in correct position between existing symbols
src/lib/utils/code.ts	Registers hcl, terraform, and tf as aliases for the ini highlight.js grammar with a comment explaining the limitation
src/redirects.json	Adds one redirect: /docs/tooling/terraform/databases → /docs/tooling/terraform/resources/databases; no broken redirect chains detected
src/routes/docs/tooling/terraform/+page.markdoc	New Terraform provider overview page with resource/data-source tables, quick-start cards, and cross-links; content is consistent with child pages
src/routes/docs/tooling/terraform/provider/+page.markdoc	New provider configuration page covering Cloud, Community Edition, environment variables, and project-scoping; examples use placeholder values appropriately
src/routes/docs/tooling/terraform/resources/messaging/+page.markdoc	New messaging resource docs with provider examples for Sendgrid, SMTP, Twilio, and FCM; FCM example uses file() for service account JSON
src/routes/blog/post/introducing-terraform-provider-for-appwrite/+page.markdoc	New blog post introducing the Terraform provider; changelog link correctly points to /changelog/entry/2026-04-19 matching the new changelog file
src/routes/changelog/(entries)/2026-04-19.markdoc	New changelog entry dated 2026-04-19 announcing the Terraform provider; filename matches date and blog post reference
src/routes/docs/Sidebar.svelte	Adds Terraform provider entry to the tooling sidebar using web-icon-terraform; positioned correctly among peer tooling entries
src/routes/integrations/terraform-provider/+page.markdoc	New integrations catalog entry for the Terraform provider with correct metadata and cross-links to docs

_{Reviews (9): Last reviewed commit: "Merge branch 'main' into docs/terraform-..." | Re-trigger Greptile}

greptile-apps · 2026-04-09T06:03:09Z

+}
+```
+
+## Topics {% #topics %}
+


Missing warning about committing service account JSON to git

The FCM example reads credentials with file("firebase-service-account.json") but there is no note warning users to add that file to .gitignore and never commit it. Readers following this example for the first time may inadvertently leak their service account key.

Consider adding a short note here:

Important: Add firebase-service-account.json to your .gitignore. Never commit secret files to version control; use environment variables or a secrets manager for CI.

Resolve conflicts: icon sprite/types (terraform + restored mongo), changelog split for 2026-04-08 entries, github-stars, and regenerated icon output. Made-with: Cursor

Made-with: Cursor

…s, assets Align TablesDB resource names and capabilities; add Auth, Functions, Sites, Webhooks, and Backups pages; fold data source into Databases; update redirects. Refresh Terraform blog, changelog, and integration copy; new covers and avatar. Made-with: Cursor

Made-with: Cursor

levivannoort · 2026-04-17T07:08:04Z

I think this blog is still missing some resources, other than that it looks fine. I did a rewrite of it here: https://github.com/appwrite/website/pull/2887/changes#diff-77917839cc715ba8a72fb8737c10434dfdfd13fd29086b3f7d9837fb26deca5c

atharvadeosthale · 2026-04-17T08:30:21Z

+---
+layout: changelog
+title: "Terraform provider for Appwrite"
+date: 2026-04-17


Suggested change

date: 2026-04-17

date: 2026-04-19

Made-with: Cursor

…ields Made-with: Cursor

Add appwrite_function_deployment and appwrite_site_deployment resources with code and template examples, and document the new data sources (storage_bucket, auth_user, auth_team, function, site, messaging_topic, webhook) on each product page and the overview. Made-with: Cursor

adityaoberai · 2026-04-23T12:36:32Z

+| Webhooks | `appwrite_webhook` |
+| Backups | `appwrite_backup_policy` |
+
+| Kind | Name | Description |


Do we need a separate subheading before this?

adityaoberai · 2026-04-23T12:37:35Z

+- **Provider** - A plugin that teaches Terraform how to talk to a specific API (here, Appwrite).
+- **Resource** - Something Terraform should create and manage (for example an Appwrite database or table).
+- **State** - Terraform remembers what it already created so the next run can update or destroy only what changed.
+- **Plan / apply** - You run `terraform plan` to preview changes, then `terraform apply` to execute them.


Suggested change

- **Provider** - A plugin that teaches Terraform how to talk to a specific API (here, Appwrite).

- **Resource** - Something Terraform should create and manage (for example an Appwrite database or table).

- **State** - Terraform remembers what it already created so the next run can update or destroy only what changed.

- **Plan / apply** - You run `terraform plan` to preview changes, then `terraform apply` to execute them.

- **Provider**: A plugin that teaches Terraform how to talk to a specific API (here, Appwrite).

- **Resource**: Something Terraform should create and manage (for example an Appwrite database or table).

- **State**: Terraform remembers what it already created so the next run can update or destroy only what changed.

- **Plan / apply**: You run `terraform plan` to preview changes, then `terraform apply` to execute them.

adityaoberai · 2026-04-23T12:47:00Z

                    isParent: true
                },
+                {
+                    label: 'Terraform provider',


Suggested change

label: 'Terraform provider',

label: 'Terraform',

I don't think provider is necessary here

eldadfux added 21 commits April 8, 2026 16:50

docs: add Terraform provider section under Tooling

c0528cf

Add overview with Terraform basics, self-hosting redirect note, and guides for provider configuration, database resources, and data sources. Link to appwrite/terraform-provider-appwrite; align content with README. Made-with: Cursor

fix(docs): register hcl/tf for Terraform code blocks in highlight.js

bd2c90e

Made-with: Cursor

docs(terraform): rename Provider configuration label to Configuration

8aa828c

Made-with: Cursor

docs(terraform): use regional Cloud endpoint placeholder in configura…

f8e80ed

…tion Made-with: Cursor

docs(nav): label Terraform section as Terraform provider

992dba3

Made-with: Cursor

feat(icons): add Terraform logo for Terraform provider docs nav

458a4b9

Add terraform.svg to icon pipeline (svgtofont + sprite), use web-icon-terraform in docs Tooling menu. Colors normalized by optimizer; sidebar uses currentColor like other nav icons. Made-with: Cursor

docs(nav): place Terraform provider below CLI in Tooling menu

ac37118

Made-with: Cursor

chore: refresh GitHub stars data

81b9695

Made-with: Cursor

docs(terraform): link Terraform Registry (latest and 0.0.4), align wi…

ec1dc5b

…th registry docs Add registry URLs for provider index, generated docs, and per-resource pages. Pin required_providers example to ~> 0.0.4; cross-link GitHub for source. Made-with: Cursor

docs(terraform): drop pinned versions; point to latest registry docs …

3c8a75e

…only Made-with: Cursor

docs(terraform): GitHub repo link as card with icon in registry section

f19b38a

Made-with: Cursor

docs(terraform): pair GitHub and Registry cards, compact copy, ASCII …

a2c5911

…hyphens Made-with: Cursor

docs(terraform): drop redundant data source label on appwrite_databas…

64b4b50

…e heading Made-with: Cursor

feat: changelog and integrations entry for Terraform provider docs

e2ea1cd

Add 2026-04-08 changelog on IaC value, docs, registry, and catalog. Add integrations/terraform-provider page under Deployments with cover and avatar SVGs. Made-with: Cursor

blog: add Introducing Terraform support for Appwrite projects

5317381

Product announcement with docs, registry, and integrations links; cover SVG. Made-with: Cursor

docs(blog): Terraform provider post, Levi author, and Terraform doc t…

a53f419

…weaks Add introducing-terraform-provider-for-appwrite post and levi-van-noort author. Use ASCII hyphens in Terraform provider and databases docs. Include icon font output assets and avatar. Made-with: Cursor

chore(icons): remove accidental macOS duplicate output files (* 2.*)

5ceeb75

These copies are not produced by the icon build; drop them from the repo. Made-with: Cursor

chore(gitignore): ignore macOS duplicate copies in src/icons/output

c02c72e

Prevents accidental commits of Finder "file 2.ext" duplicates. Made-with: Cursor

revert: drop gitignore rule for local icon duplicate files

370f152

Made-with: Cursor

docs(blog): use distinct ids and names in Terraform examples

bb1aed1

Made-with: Cursor

greptile-apps Bot reviewed Apr 9, 2026

View reviewed changes

eldadfux added 2 commits April 16, 2026 16:45

Merge branch 'main' into docs/terraform-provider

0b91cda

Resolve conflicts: icon sprite/types (terraform + restored mongo), changelog split for 2026-04-08 entries, github-stars, and regenerated icon output. Made-with: Cursor

chore(changelog): rename Terraform entry to 2026-04-17

7103c81

Made-with: Cursor

greptile-apps Bot reviewed Apr 17, 2026

View reviewed changes

Comment thread src/routes/blog/post/introducing-terraform-provider-for-appwrite/+page.markdoc Outdated

eldadfux added 4 commits April 16, 2026 21:59

chore(icons): update web icon bundle, sprite, and IconType

7202eca

Made-with: Cursor

chore: refresh optimize cache and Terraform-related images

f50c5f7

Made-with: Cursor

chore(changelog): rename Terraform entry to 2026-04-19

cd6066b

Made-with: Cursor

greptile-apps Bot reviewed Apr 17, 2026

View reviewed changes

Comment thread src/routes/blog/post/introducing-terraform-provider-for-appwrite/+page.markdoc Outdated

levivannoort reviewed Apr 17, 2026

View reviewed changes

atharvadeosthale reviewed Apr 17, 2026

View reviewed changes

eldadfux and others added 4 commits April 17, 2026 07:41

docs(terraform): refresh blog rewrite, changelog, integration, redirects

74ea921

Made-with: Cursor

docs(terraform): update webhooks resource for tls, auth, and secret f…

9c7df98

…ields Made-with: Cursor

Merge branch 'main' into docs/terraform-provider

c5d7d35

adityaoberai reviewed Apr 23, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs/terraform provider#2874

Docs/terraform provider#2874
eldadfux wants to merge 31 commits intomainfrom
docs/terraform-provider

eldadfux commented Apr 9, 2026

Uh oh!

greptile-apps Bot commented Apr 9, 2026 •

edited

Loading

Uh oh!

Uh oh!

greptile-apps Bot Apr 9, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

levivannoort Apr 17, 2026

Uh oh!

atharvadeosthale Apr 17, 2026

Uh oh!

adityaoberai Apr 23, 2026

Uh oh!

adityaoberai Apr 23, 2026

Uh oh!

adityaoberai Apr 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

eldadfux commented Apr 9, 2026

What does this PR do?

Test Plan

Related PRs and Issues

Have you read the Contributing Guidelines on issues?

Uh oh!

greptile-apps Bot commented Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Greptile Summary

Confidence Score: 5/5

Important Files Changed

Uh oh!

Uh oh!

greptile-apps Bot Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

levivannoort Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

atharvadeosthale Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

adityaoberai Apr 23, 2026

Choose a reason for hiding this comment

Uh oh!

adityaoberai Apr 23, 2026

Choose a reason for hiding this comment

Uh oh!

adityaoberai Apr 23, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

greptile-apps Bot commented Apr 9, 2026 •

edited

Loading