Skip to content

Docs/terraform provider#2874

Merged
adityaoberai merged 36 commits intomainfrom
docs/terraform-provider
Apr 24, 2026
Merged

Docs/terraform provider#2874
adityaoberai merged 36 commits intomainfrom
docs/terraform-provider

Conversation

@eldadfux
Copy link
Copy Markdown
Member

@eldadfux eldadfux commented Apr 9, 2026

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

eldadfux added 21 commits April 8, 2026 16:50
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
… 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
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
…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
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
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 9, 2026

Greptile Summary

This PR adds the official Terraform provider documentation to the Appwrite website, including a full docs section under /docs/tooling/terraform, a blog post, a changelog entry, an integrations page, and the Terraform icon added to the icon system. The previous review concerns (changelog link correctness, 'mongo' in IconType, HCL syntax highlighting, FCM service-account file warning) have been iterated on; the current state shows the changelog filename and blog post link are now aligned at 2026-04-24, and 'mongo' is no longer missing from the current diff.

Confidence Score: 5/5

Safe to merge — all substantive issues raised in prior review rounds have been addressed or are P2 style notes.

No new P0 or P1 findings. All changed files are either generated icon assets, new documentation pages, or small additive code changes. The changelog filename, blog post link, and sidebar icon are internally consistent. Remaining open items from previous threads are either resolved or low-severity documentation suggestions.

No files require special attention.

Important Files Changed

Filename Overview
src/routes/docs/tooling/terraform/+layout.svelte New Terraform docs layout; parent nav pattern (href: '/docs') is consistent with MCP, CLI, and AI tooling layouts.
src/routes/docs/tooling/terraform/+page.markdoc Overview page listing all resources and data sources; content accurate and well-structured.
src/routes/docs/tooling/terraform/provider/+page.markdoc Configuration page covering Cloud/CE endpoints, env vars, and API key scoping; all examples use placeholder values correctly.
src/routes/docs/tooling/terraform/resources/messaging/+page.markdoc Messaging docs with provider/topic/subscriber examples; FCM example uses file() to read a service account JSON from disk.
src/lib/components/ui/icon/types.ts Adds 'terraform' to IconType union; existing members preserved in current diff state.
src/lib/utils/code.ts Registers hcl/terraform/tf as aliases for ini highlighting with an explanatory comment; functional but limited fidelity for HCL.
src/redirects.json Adds proactive redirect for /docs/tooling/terraform/databases → /docs/tooling/terraform/resources/databases; no other short-path aliases added for storage, auth, etc.
src/routes/blog/post/introducing-terraform-provider-for-appwrite/+page.markdoc Blog post announcing the Terraform provider; changelog link targets /changelog/entry/2026-04-24, which matches the new 2026-04-24.markdoc filename.
src/routes/changelog/(entries)/2026-04-24.markdoc New changelog entry dated 2026-04-24; filename, frontmatter date, and all internal links are consistent.
src/routes/docs/Sidebar.svelte Adds Terraform entry to the tooling sidebar using web-icon-terraform, consistent with the newly generated web-icon output files.
src/lib/components/ui/icon/sprite/sprite.svelte Adds SVG sprite; inserted between existing symbols without removing any others.

Reviews (13): Last reviewed commit: "Add new examples for Auth, Databases, Fu..." | Re-trigger Greptile

Comment thread src/lib/components/ui/icon/types.ts Outdated
Comment on lines +60 to +64
}
```

## Topics {% #topics %}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread src/lib/utils/code.ts
Resolve conflicts: icon sprite/types (terraform + restored mongo), changelog
split for 2026-04-08 entries, github-stars, and regenerated icon output.

Made-with: Cursor
Comment thread src/routes/blog/post/introducing-terraform-provider-for-appwrite/+page.markdoc Outdated
…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
Comment thread src/routes/blog/post/introducing-terraform-provider-for-appwrite/+page.markdoc Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

---
layout: changelog
title: "Terraform provider for Appwrite"
date: 2026-04-17
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
date: 2026-04-17
date: 2026-04-19

eldadfux and others added 4 commits April 17, 2026 07:41
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
| Webhooks | `appwrite_webhook` |
| Backups | `appwrite_backup_policy` |

| Kind | Name | Description |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need a separate subheading before this?

Comment thread src/routes/docs/tooling/terraform/+page.markdoc Outdated
Comment thread src/routes/docs/Sidebar.svelte Outdated
@adityaoberai adityaoberai merged commit 49842aa into main Apr 24, 2026
6 checks passed
@adityaoberai adityaoberai deleted the docs/terraform-provider branch April 24, 2026 14:01
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.

4 participants