Skip to content

chore: update the documentation and the terraform blog#2887

Open
levivannoort wants to merge 1 commit intodocs/terraform-providerfrom
terraform-blog-changes
Open

chore: update the documentation and the terraform blog#2887
levivannoort wants to merge 1 commit intodocs/terraform-providerfrom
terraform-blog-changes

Conversation

@levivannoort
Copy link
Copy Markdown
Member

@levivannoort levivannoort commented Apr 14, 2026

What does this PR do?

Update the documentation and blog around terraform

Test Plan

N/A

Related PRs and Issues

N/A

Have you read the Contributing Guidelines on issues?

Yes

@appwrite
Copy link
Copy Markdown

appwrite bot commented Apr 14, 2026

Appwrite Website

Project ID: 69d7efb00023389e8d27

Sites (1)
Site Status Logs Preview QR
 website
69d7f2670014e24571ca
Building Building View Logs Preview URL QR Code

Website (appwrite/website)

Project ID: 684969cb000a2f6c0a02

Sites (1)
Site Status Logs Preview QR
 website
68496a17000f03d62013
Processing Processing View Logs Preview URL QR Code


Tip

Preview deployments create instant URLs for every branch and commit

@levivannoort levivannoort requested a review from eldadfux April 14, 2026 08:03
@levivannoort levivannoort marked this pull request as ready for review April 17, 2026 06:09
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Apr 17, 2026

Greptile Summary

This PR adds the full documentation set and a blog post for the official Appwrite Terraform provider (appwrite/appwrite), covering the overview, provider configuration, and resource guides for Databases, Storage, Functions, Sites, Auth, Messaging, Webhooks, and Backup Policies. All 13 files are documentation-only (.markdoc / .svelte) with no runtime logic changes.

Confidence Score: 5/5

Safe to merge — documentation-only PR with no runtime logic changes.

All findings are P2 (style/documentation clarity). Both the parent nav label mismatch and the data-source ID ambiguity are minor content issues that don't break functionality.

src/routes/docs/tooling/terraform/+layout.svelte (parent nav href), src/routes/docs/tooling/terraform/data-sources/+page.markdoc (example id value)

Important Files Changed

Filename Overview
src/routes/blog/post/introducing-terraform-provider-for-appwrite/+page.markdoc Blog post updated with consistent TablesDB naming, provider version 1.0.1, and cross-links to docs.
src/routes/docs/tooling/terraform/+layout.svelte Sidebar layout added for Terraform docs section; parent nav label doesn't match its href destination.
src/routes/docs/tooling/terraform/+page.markdoc Overview page with resource table, Terraform concepts, and next-steps cards — looks correct.
src/routes/docs/tooling/terraform/data-sources/+page.markdoc Data sources page; the example id="main" mirrors the database name from the databases guide, potentially misleading users who expect the name to serve as a lookup key.
src/routes/docs/tooling/terraform/provider/+page.markdoc Provider configuration page with Cloud/CE examples, env vars table, and API key guidance — looks correct.
src/routes/docs/tooling/terraform/resources/auth/+page.markdoc Auth resource docs for users and teams with clear examples — looks correct.
src/routes/docs/tooling/terraform/resources/backup-policies/+page.markdoc Backup policies resource docs with daily and scoped examples — looks correct.
src/routes/docs/tooling/terraform/resources/databases/+page.markdoc Databases resource docs covering full schema setup (columns, indexes, rows) — looks correct.
src/routes/docs/tooling/terraform/resources/functions/+page.markdoc Functions resource docs with schedule, event, VCS integration, and env variable examples — looks correct.
src/routes/docs/tooling/terraform/resources/messaging/+page.markdoc Messaging resource docs with provider, topic, and subscriber examples — looks correct.
src/routes/docs/tooling/terraform/resources/sites/+page.markdoc Sites resource docs with static, Next.js, Astro, env vars, and VCS examples — looks correct.
src/routes/docs/tooling/terraform/resources/storage/+page.markdoc Storage resource docs for buckets and file uploads — looks correct.
src/routes/docs/tooling/terraform/resources/webhooks/+page.markdoc Webhooks resource docs with basic, multi-event, and authenticated examples — looks correct.

Comments Outside Diff (1)

  1. src/routes/docs/tooling/terraform/+layout.svelte, line 5-8 (link)

    P2 Parent nav label/href mismatch

    The parent breadcrumb has label: 'Terraform provider' but links to href: '/docs' (the docs root). A user clicking "Terraform provider" in the sidebar breadcrumb will land on the generic docs home instead of the Terraform section. The label should describe the destination, not the current section — either point the href at a parent like /docs/tooling, or use a label that matches where /docs actually takes the user (e.g. 'Docs').

Reviews (1): Last reviewed commit: "chore: update the documentation and the ..." | Re-trigger Greptile

Comment on lines 15 to 18
```hcl
data "appwrite_database" "existing" {
data "appwrite_tablesdb" "existing" {
id = "main"
}
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 Data source id looks like a name, not an ID

The example uses id = "main", the same string that appears as the name in the databases guide's appwrite_tablesdb.main resource. Without an explicit id argument on the resource, Appwrite auto-generates the ID — so id = "main" would fail to resolve at runtime for any database that was not created with a custom ID of "main". A brief clarifying comment (e.g. # the Appwrite database ID, not the name) or a more obviously placeholder value (e.g. "existing-db-id") would prevent the confusion.

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.

1 participant