React sign up template
+React tutorial
- Lorem ipsum dolor sit amet, consectetur adipiscing elit. + Learn Appwrite Auth, Databases, and more with React.
diff --git a/src/icons/svg/microsoft.svg b/src/icons/svg/microsoft.svg index 96fe4720d4..7d8dc08cbf 100644 --- a/src/icons/svg/microsoft.svg +++ b/src/icons/svg/microsoft.svg @@ -1 +1 @@ - \ No newline at end of file + diff --git a/src/icons/svg/platform.svg b/src/icons/svg/platform.svg new file mode 100644 index 0000000000..45d54cc837 --- /dev/null +++ b/src/icons/svg/platform.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/src/icons/svg/rest.svg b/src/icons/svg/rest.svg new file mode 100644 index 0000000000..a77906d376 --- /dev/null +++ b/src/icons/svg/rest.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/src/lib/components/FooterNav.svelte b/src/lib/components/FooterNav.svelte index f916cf7d44..5ccb73d72c 100644 --- a/src/lib/components/FooterNav.svelte +++ b/src/lib/components/FooterNav.svelte @@ -135,6 +135,7 @@
- Inspire and get inspired. Join our community of maintainers and contributors and + Inspire and get inspired. Join Appwrite's community of maintainers and contributors and help us make Appwrite better for developers worldwide.
- After a year of building out in the open we closed our first funding round led by Ibex Investors, Seedcamp, and the Abraham Fund. With this new financial power we hired some of the top contributors in our open-source community. To this day we still hire people from our community. + After a year of building out in the open we closed our first funding round led by Ibex Investors, Seedcamp, and the Abraham Fund. With this new financial power we hired some of the top contributors in our open-source community. To this day we still hire people from the open-source community.
+
- Start building today by creating an account on Appwrite Cloud - or - self-host. + Appwrite is a backend development platform built by hundreds of open-source developers, where you can build any application at any scale using the coding languages and tools you want.
- If you learn best from code examples, follow one of our tutorials.. + If you learn best from code examples, follow one of our tutorials.
- Lorem ipsum dolor sit amet, consectetur adipiscing elit. + Learn Appwrite Auth, Databases, and more with React.
- Lorem ipsum dolor sit amet, consectetur adipiscing elit. -
+ Learn Appwrite Auth, Databases, and more with SvelteKit. +
- Lorem ipsum dolor sit amet, consectetur adipiscing elit. + Learn Appwrite Auth, Databases, and more with Vue.
- Lorem ipsum dolor sit amet, consectetur adipiscing elit. -
+ Coming soon... +
- Lorem ipsum dolor sit amet, consectetur adipiscing elit. -
+ Coming soon... +Light-weight SDKs for your favorite platforms. @@ -541,17 +574,17 @@
- Integrate with HTTP requests without the needing an SDK + Integrate with HTTP requests without the needing an SDK.
Migrate users and data from NHost to Appwrite. diff --git a/src/routes/docs/Sidebar.svelte b/src/routes/docs/Sidebar.svelte index 0377f634f5..159c7528bd 100644 --- a/src/routes/docs/Sidebar.svelte +++ b/src/routes/docs/Sidebar.svelte @@ -10,7 +10,7 @@ icon: 'icon-home' }, { - label: 'Quick Start', + label: 'Quick start', href: '/docs/quick-starts', icon: 'icon-play' }, @@ -72,7 +72,7 @@ { label: 'REST', href: '/docs/apis/rest', - icon: 'icon-play' + icon: 'aw-icon-rest' }, { label: 'GraphQL', @@ -103,7 +103,7 @@ { label: 'Platform', href: '/docs/advanced/platform', - icon: 'icon-play', + icon: 'aw-icon-platform', isParent: true }, { diff --git a/src/routes/docs/advanced/integration/+page.markdoc b/src/routes/docs/advanced/integration/+page.markdoc index 60319d3fd8..dc9b13b26f 100644 --- a/src/routes/docs/advanced/integration/+page.markdoc +++ b/src/routes/docs/advanced/integration/+page.markdoc @@ -2,7 +2,5 @@ layout: article title: Integration description: Learn how to migrate your projects from other vendors to Appwrite Cloud or how to move from self-hosting to Cloud and the other way around using Appwrite Migrations service. -difficulty: beginner -readtime: 5 --- Integration \ No newline at end of file diff --git a/src/routes/docs/advanced/migrations/cloud/+page.markdoc b/src/routes/docs/advanced/migrations/cloud/+page.markdoc index 5c0ef5ae91..ba0c0803c8 100644 --- a/src/routes/docs/advanced/migrations/cloud/+page.markdoc +++ b/src/routes/docs/advanced/migrations/cloud/+page.markdoc @@ -1,12 +1,11 @@ --- layout: article title: Migrate from self-hosted -description: This is the description used for SEO. +description: Migrate to Appwrite from cloud platforms seamlessly. Learn how to move your applications and data to Appwrite for enhanced flexibility and control. difficulty: beginner -readtime: 20 +readtime: 10 --- - -Making the move to Appwrite Cloud? We've got your back. + Migrations makes it as easy as a couple clicks to move all of your self-hosted project data to a Cloud instance. @@ -33,7 +32,7 @@ and [things to keep in mind](#notices) sections above. {% /section %} -{% section #create-migration step=3 title="Continue on Appwrite Cloud" %} +{% section #continue-on-cloud step=3 title="Continue on Appwrite Cloud" %} 1. Once redirected to Appwrite Cloud, you'll be prompted to select an organization and a project. You can migrate to an existing project or create a new one. diff --git a/src/routes/docs/advanced/migrations/firebase/+page.markdoc b/src/routes/docs/advanced/migrations/firebase/+page.markdoc index abd75719dc..7c5c01a715 100644 --- a/src/routes/docs/advanced/migrations/firebase/+page.markdoc +++ b/src/routes/docs/advanced/migrations/firebase/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Migrate from Firebase -description: Learn how to migrate your Firebase project to Appwrite Cloud. +description: Migrate seamlessly from Firebase to Appwrite. Learn how to transfer data, authentication, and services from Firebase to leverage Appwrite's capabilities. difficulty: beginner readtime: 20 --- diff --git a/src/routes/docs/advanced/migrations/nhost/+page.markdoc b/src/routes/docs/advanced/migrations/nhost/+page.markdoc index ffff7a66e7..c913a3e06f 100644 --- a/src/routes/docs/advanced/migrations/nhost/+page.markdoc +++ b/src/routes/docs/advanced/migrations/nhost/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Migrate from Nhost -description: Learn how to migrate your Nhost project to Appwrite Cloud. +description: Transition to Appwrite from NHost with confidence. Explore migration steps, considerations, and tools to ensure a successful migration process. difficulty: beginner readtime: 20 --- diff --git a/src/routes/docs/advanced/migrations/self-hosted/+page.markdoc b/src/routes/docs/advanced/migrations/self-hosted/+page.markdoc index 9834a392b1..160588a05d 100644 --- a/src/routes/docs/advanced/migrations/self-hosted/+page.markdoc +++ b/src/routes/docs/advanced/migrations/self-hosted/+page.markdoc @@ -1,13 +1,12 @@ --- layout: article -title: Migrate from Self-hosted -description: This is the description used for SEO. +title: Migrate from Cloud +description: Self-hosted application migration made easy with Appwrite. Discover the steps and strategies for migrating your self-hosted apps to Appwrite's managed platform. difficulty: beginner readtime: 20 --- -Making the move to Appwrite Cloud? We've got your back. -Migrations make it as easy as a couple of clicks to move all your self-hosted project data to a Cloud instance. +Migrations make it as easy as a couple of clicks to move all your Appwrite Cloud data into a self-hosted instance. {% section #notices step=1 title="Things to keep in mind" %} @@ -32,9 +31,9 @@ To begin migrating to self-hosted, make sure to read the [migration overview](/d {% /section %} -{% section #create-migration step=3 title="Continue on self-hosted" %} +{% section #continue-on-self-hosted step=3 title="Continue on self-hosted" %} -1. Once redirected to Appwrite Cloud, you'll be prompted to select an organization and a project. You can migrate to an existing project or create a new one. +1. Once redirected to your self-hosted project, you'll be prompted to select an organization and a project. You can migrate to an existing project or create a new one. 1. Select the data you wish to migrate. You can choose among accounts, databases, documents, files, and functions. diff --git a/src/routes/docs/advanced/migrations/supabase/+page.markdoc b/src/routes/docs/advanced/migrations/supabase/+page.markdoc index 4da883c2c9..4c2d6e55f5 100644 --- a/src/routes/docs/advanced/migrations/supabase/+page.markdoc +++ b/src/routes/docs/advanced/migrations/supabase/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Migrate from Supabase -description: Learn how to migrate your Supabase project to Appwrite Cloud. +description: Effortlessly migrate from Supabase to Appwrite. Discover migration strategies, data transfer methods, and tips for a smooth transition to Appwrite. difficulty: beginner readtime: 20 --- diff --git a/src/routes/docs/advanced/platform/+page.markdoc b/src/routes/docs/advanced/platform/+page.markdoc index b751f4402f..4b84a7dd07 100644 --- a/src/routes/docs/advanced/platform/+page.markdoc +++ b/src/routes/docs/advanced/platform/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Platform -description: Description for SEO. +description: Appwrite is a development platform designed to adapt you unique use cases. Appwrite provides features that help you maintain, scale, and integrate Appwrite with other platforms. --- Appwrite is a development platform designed to adapt your unique use cases. diff --git a/src/routes/docs/advanced/platform/api-keys/+page.markdoc b/src/routes/docs/advanced/platform/api-keys/+page.markdoc index b8c7d68403..6515eec64d 100644 --- a/src/routes/docs/advanced/platform/api-keys/+page.markdoc +++ b/src/routes/docs/advanced/platform/api-keys/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: API keys -description: Placeholder SEO. +description: Secure your application with Appwrite API Keys. Discover how to create and manage API keys to control access and enhance your application's security. --- API keys are secrets used by Appwrite [Server SDKs](/docs/sdks#server) and the Appwrite CLI to prove their identity. @@ -14,6 +14,13 @@ API keys should be treated as a secret. Never share the API key and keep API key # Create API key {% #create-api-key %} +{% only_dark %} + +{% /only_dark %} +{% only_light %} + +{% /only_light %} + To create a new API key, navigate to **Overview** > **Integration** > **API keys** and click **Create API key**. When adding a new API Key, you can choose which [scopes](#scopes) to grant your application. diff --git a/src/routes/docs/advanced/platform/custom-domains/+page.markdoc b/src/routes/docs/advanced/platform/custom-domains/+page.markdoc index 681e5d44ca..abe9a77ff9 100644 --- a/src/routes/docs/advanced/platform/custom-domains/+page.markdoc +++ b/src/routes/docs/advanced/platform/custom-domains/+page.markdoc @@ -1,12 +1,12 @@ --- layout: article title: Custom domains -description: Placeholder SEO. +description: Customize your Appwrite platform with custom domains. Learn how to set up and configure custom domains to provide a branded experience for your users. --- Appwrite custom domains allows you to use your own domain as your Appwrite API endpoint. -# Third-party cookies +# Third-party cookies {% #third-party-cookies %} A recent change made in modern browsers will not allow your web app to use 3rd-party cookies. This change is done to protect your users' privacy from malicious web tracking services. @@ -17,7 +17,7 @@ as a fallback Appwrite will store your users' sessions on the browser localStora Using localStorage is very convenient to help you get started quickly with Appwrite, but it is not the best practice for your users' security. The browser localStorage can't protect your users' sessions from being hijacked by a 3rd party script or an XSS vulnerability in your web app. -# Appwrite API endpoint +# Appwrite API endpoint {% #endpoint %} To prevent your browser from blocking your cookies, your Appwrite API endpoint should be set to under same domain of your web app's domain. When accessing Appwrite from the same domain as the one your app uses, Appwrite cookies will no longer be treated as 3rd-party cookies by any browser and will store your users' sessions securely. @@ -26,7 +26,7 @@ For example, if your app runs on [my-app.com](https://my-app.com), you can set the subdomain [appwrite.my-app.com](https://appwrite.my-app.com) to access the Appwrite API. This will allow browsers to respect the Appwrite sessions cookies as they are set on the same domain as your app. -# Add a custom domain +# Add a custom domain {% #domain %} 1. Go to the Appwrite Console and navigate to your project. 2. Click on the **Settings** tab in the left sidebar. diff --git a/src/routes/docs/advanced/platform/events/+page.markdoc b/src/routes/docs/advanced/platform/events/+page.markdoc index 0701f8cd80..a7d7b50127 100644 --- a/src/routes/docs/advanced/platform/events/+page.markdoc +++ b/src/routes/docs/advanced/platform/events/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Events -description: Placeholder SEO. +description: Harness the power of events in Appwrite. Explore event-driven architecture, event types, and how to use events to create dynamic and responsive applications. --- Appwrite provides a variety of events that allows your application to react to changes as they happen. diff --git a/src/routes/docs/advanced/platform/message-templates/+page.markdoc b/src/routes/docs/advanced/platform/message-templates/+page.markdoc index db34462511..64bf41e92f 100644 --- a/src/routes/docs/advanced/platform/message-templates/+page.markdoc +++ b/src/routes/docs/advanced/platform/message-templates/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Message templates -description: Placeholder SEO. +description: Communicate using your brand and voice by customizing email and SMS message templates, localized to your user's language. --- Appwrite uses emails to communicate with users to perform authentication and verification actions. Emails can be customized to fit your app's design and voice. diff --git a/src/routes/docs/advanced/platform/permissions/+page.markdoc b/src/routes/docs/advanced/platform/permissions/+page.markdoc index a71ad04b27..5d04515b5e 100644 --- a/src/routes/docs/advanced/platform/permissions/+page.markdoc +++ b/src/routes/docs/advanced/platform/permissions/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Permissions -description: Placeholder SEO. +description: Enhance data security and access control with Appwrite platform permissions. Learn how to set fine-grained permissions to protect user data and resources. --- Appwrite's permission mechanism offers a simple, yet flexible way to manage which users, teams, or roles can access a specific resource in your project, such as documents and files. @@ -14,23 +14,23 @@ All permissions can be granted to individuals or groups of users, entire teams, A project user can only grant permissions to a resource that they own. For example, if a user is trying to share a document with a team that they are not a member of, they will encounter a 401 not authorized error. If your app needs users to grant access to teams they're not a member of, you can create Appwrite Functions with a [Server SDK](/docs/sdks#server) to achieve this functionality. -# Appwrite Resource +# Appwrite resource {% #appwrite-resource %} An Appwrite resource can be a database, collection, document, bucket, or file. Each resource has its own set of permissions to define who can interact with it. Using the Appwrite permissions mechanism, you can grant resource access to users, teams, and members with different roles. -# Default Values +# Default values {% #default-values %} If you create a resource using a Server SDK or the Appwrite Console without explicit permissions, no one can access it by default because the permissions will be empty. If you create a resource using a Client SDK without explicit permissions, the creator will be granted read, update, and delete permissions on that resource by default. -# Server Integration +# Server integration {% #server-integration %} Server integrations can be used for increased flexibility. When using a Server SDK in combination with the proper [API key scopes](/docs/advanced/platform/api-keys#scopes), you can have any type of access to any of your project resources regardless of their permissions. Using the server integration flexibility, you can change resource permissions, share resources between different users and teams, or edit and delete them without any limitations. -# Permission Types +# Permission types {% #permission-types %} In Client and Server SDKs, you will find a **Permission** class with helper methods for each role described below: @@ -42,7 +42,7 @@ In Client and Server SDKs, you will find a **Permission** class with helper meth | `Permission.delete()` | Access to remove a resource. Does not apply to functions. | | `Permission.write()` | Alias to grant create, update, and delete access for collections and buckets and update and delete access for documents and files. | -# Permission Roles +# Permission roles {% #permission-roles %} In Client and Server SDKs, you will find a **Role** class with helper methods for each role described below: @@ -57,7 +57,7 @@ In Client and Server SDKs, you will find a **Role** class with helper methods fo | `Role.member([MEMBERSHIP_ID])` | Grants access to a specific member of a team. When the member is removed from the team, they will no longer have access. | | `Role.label([LABEL_ID])` | Grants access to all accounts with a specific label ID. Once the label is removed from the user, they will no longer have access. [Learn more about labels](/docs/products/auth/labels). | -# Examples +# Examples {% #examples %} The examples below will show you how you can use the different Appwrite permissions to manage access control to your project resources. @@ -96,7 +96,7 @@ promise.then(function (response) { }); ``` -## Example #2 - Team roles +## Example #2 - Team roles {% #examples-2 %} In the following example, we are creating a document that can be read by members of the team with ID `5c1f88b87435e` and can only be edited or deleted by members of the same team that possess the team role `owner`. diff --git a/src/routes/docs/advanced/platform/rate-limits/+page.markdoc b/src/routes/docs/advanced/platform/rate-limits/+page.markdoc index 083ce28f75..6125031277 100644 --- a/src/routes/docs/advanced/platform/rate-limits/+page.markdoc +++ b/src/routes/docs/advanced/platform/rate-limits/+page.markdoc @@ -1,10 +1,10 @@ --- layout: article title: Rate-limits -description: Placeholder SEO. +description: Optimize application performance with Appwrite rate limits. Explore rate limiting strategies, configurations, and how to prevent abuse of your services. --- -# Appwrite Rate Limits +# Appwrite rate limits {% #appwrite-rate-limits %} Some of Appwrite's API endpoints have a rate limit to avoid abuse or brute-force attacks against Appwrite's REST API. Each Appwrite route documentation has information about any rate limits that might apply to them. @@ -50,7 +50,7 @@ X-RateLimit-Reset: 1377013266 } ``` -# Service Abuse +# Service abuse {% #service-abuse %} To protect the quality of service from Appwrite, additional rate limits may apply to some actions. For example, rapidly creating content, polling aggressively instead of using webhooks, making API calls with a high concurrency, or repeatedly requesting data that is computationally expensive may result in abuse rate limiting. diff --git a/src/routes/docs/advanced/platform/response-codes/+page.markdoc b/src/routes/docs/advanced/platform/response-codes/+page.markdoc index 029d2c3214..607802dca2 100644 --- a/src/routes/docs/advanced/platform/response-codes/+page.markdoc +++ b/src/routes/docs/advanced/platform/response-codes/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Response codes -description: Placeholder SEO. +description: Understand Appwrite platform response codes for effective error handling. Learn how to interpret and handle response codes to enhance your application's reliability. --- Appwrite uses conventional HTTP response codes to indicate the success or failure of an API request. diff --git a/src/routes/docs/advanced/platform/webhooks/+page.markdoc b/src/routes/docs/advanced/platform/webhooks/+page.markdoc index 90173d36ac..601c262163 100644 --- a/src/routes/docs/advanced/platform/webhooks/+page.markdoc +++ b/src/routes/docs/advanced/platform/webhooks/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Webhooks -description: Placeholder SEO. +description: Leverage webhooks in the Appwrite platform for real-time updates. Learn how to configure, manage, and integrate webhooks to keep your applications in sync. --- Webhooks allow you to build or set up integrations which subscribe to certain events on Appwrite. When one of those events is triggered, we'll send an HTTP POST payload to the webhook's configured URL. Webhooks can be used to purge cache from CDN, calculate data or send a Slack notification. You're only limited by your imagination. diff --git a/src/routes/docs/advanced/self-hosting/+page.markdoc b/src/routes/docs/advanced/self-hosting/+page.markdoc index 0f05b1ae2b..0f52e75e62 100644 --- a/src/routes/docs/advanced/self-hosting/+page.markdoc +++ b/src/routes/docs/advanced/self-hosting/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Installation -description: Learn how to integrate Appwrite in your application with one of the supported SDKs. +description: Explore advanced self-hosting options with Appwrite. Learn how to gain full control of your Appwrite deployment, customize settings, and enhance your infrastructure. --- Appwrite was designed from the ground up with self-hosting in mind. You can install and run Appwrite on any operating system that can run a [Docker CLI](https://www.docker.com/products/docker-desktop). Self-hosted Appwrite instances can be configured flexibly with access to the same features found on Appwrite Cloud. diff --git a/src/routes/docs/advanced/self-hosting/debug/+page.markdoc b/src/routes/docs/advanced/self-hosting/debug/+page.markdoc index f7f55bf161..ac2e1bd192 100644 --- a/src/routes/docs/advanced/self-hosting/debug/+page.markdoc +++ b/src/routes/docs/advanced/self-hosting/debug/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Debug -description: Learn how to integrate Appwrite in your application with one of the supported SDKs. +description: Master debugging techniques for self-hosted Appwrite. Discover best practices and tools for troubleshooting and maintaining a robust deployment. --- Appwrite comes with a few built-in tools and methods that easily debug and investigate issues on your Appwrite stack environment. diff --git a/src/routes/docs/advanced/self-hosting/email/+page.markdoc b/src/routes/docs/advanced/self-hosting/email/+page.markdoc index 7551d02e8e..2f8ff9b1a9 100644 --- a/src/routes/docs/advanced/self-hosting/email/+page.markdoc +++ b/src/routes/docs/advanced/self-hosting/email/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Email delivery -description: Learn how to integrate Appwrite in your application with one of the supported SDKs. +description: Configure email services for your self-hosted Appwrite instance. Learn how to set up email notifications, templates, and delivery for your applications. --- Appwrite v0.7 and above come with support for easy integrations with 3rd party SMTP providers. In order for emails to work, you will need to set up proper SMTP configuration as described below. diff --git a/src/routes/docs/advanced/self-hosting/environment-variables/+page.markdoc b/src/routes/docs/advanced/self-hosting/environment-variables/+page.markdoc index e546f8ab61..9bf2c7abe2 100644 --- a/src/routes/docs/advanced/self-hosting/environment-variables/+page.markdoc +++ b/src/routes/docs/advanced/self-hosting/environment-variables/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Environment variables -description: Learn how to integrate Appwrite in your application with one of the supported SDKs. +description: Customize the behavior of your self-hosted Appwrite instance to your unique needs. Customize SMTP, sms, functions, S3 adaptor, database, and other behaiors. --- diff --git a/src/routes/docs/advanced/self-hosting/functions/+page.markdoc b/src/routes/docs/advanced/self-hosting/functions/+page.markdoc index 73ee61b528..86dfae7df8 100644 --- a/src/routes/docs/advanced/self-hosting/functions/+page.markdoc +++ b/src/routes/docs/advanced/self-hosting/functions/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Functions -description: Learn how to integrate Appwrite in your application with one of the supported SDKs. +description: Harness the full power of self-hosted functions with Appwrite. Explore function deployment, management, and integration in your self-hosted environment. --- # Configure GitHub app {% #git %} diff --git a/src/routes/docs/advanced/self-hosting/installation/+page.markdoc b/src/routes/docs/advanced/self-hosting/installation/+page.markdoc index e8a8b76d85..963cbb65a1 100644 --- a/src/routes/docs/advanced/self-hosting/installation/+page.markdoc +++ b/src/routes/docs/advanced/self-hosting/installation/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Installation -description: Learn how to integrate Appwrite in your application with one of the supported SDKs. +description: Set up your self-hosted Appwrite instance with ease. Follow the installation guide to configure and deploy Appwrite on your infrastructure for complete control. --- Appwrite was designed from the ground up with self-hosting in mind. You can install and run Appwrite on any operating system that can run a [Docker CLI](https://www.docker.com/products/docker-desktop). Self-hosted Appwrite instances can be configured flexibly with access to the same features found on Appwrite Cloud. diff --git a/src/routes/docs/advanced/self-hosting/production/+page.markdoc b/src/routes/docs/advanced/self-hosting/production/+page.markdoc index da9b1fd97c..426c013a87 100644 --- a/src/routes/docs/advanced/self-hosting/production/+page.markdoc +++ b/src/routes/docs/advanced/self-hosting/production/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Production -description: Learn how to integrate Appwrite in your application with one of the supported SDKs. +description: Optimize self-hosted Appwrite for production environments. Learn how to fine-tune performance, security, and scalability for your production deployments. --- Appwrite's default setup is designed to help you start building with Appwrite quickly. To succeed with Appwrite in a production environment, you should follow a few basic concepts and best practices. This document assumes you have some basic understanding of Docker and Docker Compose command-line tools. diff --git a/src/routes/docs/advanced/self-hosting/sms/+page.markdoc b/src/routes/docs/advanced/self-hosting/sms/+page.markdoc index e9c080d42b..78ce90728c 100644 --- a/src/routes/docs/advanced/self-hosting/sms/+page.markdoc +++ b/src/routes/docs/advanced/self-hosting/sms/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: SMS delivery -description: Learn how to integrate Appwrite in your application with one of the supported SDKs. +description: Set up SMS services for your self-hosted Appwrite instance. Discover how to configure SMS notifications, verification, and messaging for your applications. --- Appwrite supports phone authentication, which allows users to create accounts and log in using SMS messages. Appwrite requires an SMS provider to be set up before using Phone authentication. diff --git a/src/routes/docs/advanced/self-hosting/storage/+page.markdoc b/src/routes/docs/advanced/self-hosting/storage/+page.markdoc index c446f9a834..c1262c53af 100644 --- a/src/routes/docs/advanced/self-hosting/storage/+page.markdoc +++ b/src/routes/docs/advanced/self-hosting/storage/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Storage -description: Learn how to integrate Appwrite in your application with one of the supported SDKs. +description: Manage self-hosted storage options with Appwrite. Explore file storage, uploads, and customization in your self-hosted Appwrite environment. --- Appwrite's Storage Service can be configured to store files locally, or with self-hosted and cloud storage services. diff --git a/src/routes/docs/advanced/self-hosting/tls-certificates/+page.markdoc b/src/routes/docs/advanced/self-hosting/tls-certificates/+page.markdoc index c3bea8b3ad..b9a2eb3f0f 100644 --- a/src/routes/docs/advanced/self-hosting/tls-certificates/+page.markdoc +++ b/src/routes/docs/advanced/self-hosting/tls-certificates/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: TLS Certificates -description: Learn how to integrate Appwrite in your application with one of the supported SDKs. +description: Secure your self-hosted Appwrite instance with TLS certificates. Learn how to obtain, configure, and manage TLS certificates for enhanced security. --- Appwrite uses Let's Encrypt to auto-generate TLS certificates for your Appwrite instance to ensure your API traffic is appropriately encrypted. For Appwrite to properly generate certificates, a few conditions need to be met. diff --git a/src/routes/docs/advanced/self-hosting/update/+page.markdoc b/src/routes/docs/advanced/self-hosting/update/+page.markdoc index 4fe4f1d98b..68c772208c 100644 --- a/src/routes/docs/advanced/self-hosting/update/+page.markdoc +++ b/src/routes/docs/advanced/self-hosting/update/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Update -description: Learn how to integrate Appwrite in your application with one of the supported SDKs. +description: Keep your self-hosted Appwrite instance up-to-date. Learn how to perform updates, manage versions, and ensure your self-hosted Appwrite stays current. --- To upgrade your Appwrite server from an older version, you should use the Appwrite migration tool **after you have installed the new version**. The migration tool will adjust your Appwrite data to the new version's structure to make sure your Appwrite data is compatible with any internal changes. diff --git a/src/routes/docs/apis/graphql/+page.markdoc b/src/routes/docs/apis/graphql/+page.markdoc index 82826a0b15..395bbde24c 100644 --- a/src/routes/docs/apis/graphql/+page.markdoc +++ b/src/routes/docs/apis/graphql/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: GraphQL -description: Description used for SEO +description: Leverage the Appwrite GraphQL API for flexible data querying and manipulation. Explore GraphQL schema, queries, mutations, and how to integrate with your applications. --- Appwrite supports multiple protocols for accessing the server, including [REST](/docs/apis/rest), [GraphQL](/docs/apis/graphql), and [Realtime](/docs/apis/realtime). diff --git a/src/routes/docs/apis/realtime/+page.markdoc b/src/routes/docs/apis/realtime/+page.markdoc index d80b04e7d3..22a74b2af2 100644 --- a/src/routes/docs/apis/realtime/+page.markdoc +++ b/src/routes/docs/apis/realtime/+page.markdoc @@ -1,9 +1,7 @@ --- layout: article title: Realtime -description: The Appwrite Realtime allows you to listen to any Appwrite events and build an interactive and responsive user experience. -difficulty: beginner -readtime: 10 +description: Explore the power of real-time communication with the Appwrite Realtime API. Learn how to build dynamic and interactive applications with real-time data updates. --- Appwrite supports multiple protocols for accessing the server, including [REST](/docs/apis/rest), [GraphQL](/docs/apis/graphql), and [Realtime](/docs/apis/realtime). The Appwrite Realtime allows you to listen to any Appwrite events in realtime using the `subscribe` method. diff --git a/src/routes/docs/apis/rest/+page.markdoc b/src/routes/docs/apis/rest/+page.markdoc index 438fdd0302..b1fba26616 100644 --- a/src/routes/docs/apis/rest/+page.markdoc +++ b/src/routes/docs/apis/rest/+page.markdoc @@ -1,9 +1,7 @@ --- layout: article title: REST -description: -difficulty: beginner -readtime: 10 +description: Discover the Appwrite REST API for building robust and scalable applications. Access detailed documentation on REST endpoints, authentication, and data management. --- Appwrite supports multiple protocols for accessing the server, including [REST](/docs/apis/rest), [GraphQL](/docs/apis/graphql), and [Realtime](/docs/apis/realtime). The REST API allows you to access your Appwrite server through HTTP requests without the needing an SDK. Each endpoint in the API represents a specific operation on a specific resource. diff --git a/src/routes/docs/products/auth/+page.markdoc b/src/routes/docs/products/auth/+page.markdoc index 9d80aedd0f..b815a50da6 100644 --- a/src/routes/docs/products/auth/+page.markdoc +++ b/src/routes/docs/products/auth/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Authentication -description: This is the description used for SEO. +description: Explore Appwrite's powerful authentication solutions. Learn how to implement secure user authentication, manage user identities, and enhance your application's security." back: /docs --- diff --git a/src/routes/docs/products/auth/accounts/+page.markdoc b/src/routes/docs/products/auth/accounts/+page.markdoc index 98a90371eb..105fdd8015 100644 --- a/src/routes/docs/products/auth/accounts/+page.markdoc +++ b/src/routes/docs/products/auth/accounts/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Accounts -description: This is the description used for SEO. +description: Unlock advanced user management - Appwrite's Account API for seamless signups, store user preferences, and dynamic permissions. --- Appwrite Account API is used for user signup and login in client applications. diff --git a/src/routes/docs/products/auth/anonymous/+page.markdoc b/src/routes/docs/products/auth/anonymous/+page.markdoc index fda5d27a32..f58a652018 100644 --- a/src/routes/docs/products/auth/anonymous/+page.markdoc +++ b/src/routes/docs/products/auth/anonymous/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Anonymous login -description: This is the description used for SEO. +description: Manage user identities and profiles effectively with Appwrite. Dive into user management features, account settings, and user data customization. --- Anonymous sessions allow you to implement **guest** users. Guest users let you store user information like items in their cart or theme preferences before they create an account. This reduces the friction for your users to get started with your app. diff --git a/src/routes/docs/products/auth/email-password/+page.markdoc b/src/routes/docs/products/auth/email-password/+page.markdoc index 43ef291918..2ae01695ff 100644 --- a/src/routes/docs/products/auth/email-password/+page.markdoc +++ b/src/routes/docs/products/auth/email-password/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Email and password login -description: This is the description used for SEO. +description: Implement email and password authentication with Appwrite. Securely register and authenticate users in your applications using Appwrite's robust email-based authentication system. --- Email and password login is the most commonly used authentication method. Appwrite Authentication promotes a safer internet by providing secure APIs and promoting better password choices to end users. Appwrite supports added security features like blocking personal info in passwords, password dictionary, and password history to help users choose good passwords. diff --git a/src/routes/docs/products/auth/jwt/+page.markdoc b/src/routes/docs/products/auth/jwt/+page.markdoc index 5a278a9558..24f1a181b1 100644 --- a/src/routes/docs/products/auth/jwt/+page.markdoc +++ b/src/routes/docs/products/auth/jwt/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: JWT login -description: This is the description used for SEO. +description: Integrate Appwrite's authentication into your server-side applications. Explore server integrations, best practices, and security considerations for seamless authentication. --- You can extend Appwrite's APIs by building backend apps using [Server SDKs](/docs/sdks#server). To secure your backend app's APIs, client apps must prove their identity against your backend app before accessing sensitive information. You can secure these APIs and enforce access permissions in your backend app by using JWT authentication. diff --git a/src/routes/docs/products/auth/labels/+page.markdoc b/src/routes/docs/products/auth/labels/+page.markdoc index b0adad8fbf..a93eb45f33 100644 --- a/src/routes/docs/products/auth/labels/+page.markdoc +++ b/src/routes/docs/products/auth/labels/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Labels -description: This is the description used for SEO. +description: Organize your users and grant custom permissions for subscriptions or VIP users with labels. --- Labels are a good way to categorize a user to grant them access to resources. For example, a `subscriber` label can be added to a user once they've purchased a subscription. diff --git a/src/routes/docs/products/auth/magic-url/+page.markdoc b/src/routes/docs/products/auth/magic-url/+page.markdoc index 7c0fedd31b..74431482b7 100644 --- a/src/routes/docs/products/auth/magic-url/+page.markdoc +++ b/src/routes/docs/products/auth/magic-url/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Magic URL login -description: This is the description used for SEO. +description: Add magic URL to your authentication in Appwrite. Explore the convenience of passwordless login and email-based authentication using magic links." --- Magic URL is a password-less way to authenticate users. When a user logs in by providing their email, they will receive an email with a "magic" link that contains a secret used to log in the user. The user can simply click the link to be logged in. diff --git a/src/routes/docs/products/auth/oauth2/+page.markdoc b/src/routes/docs/products/auth/oauth2/+page.markdoc index 1d9fc6d3c8..d984076d17 100644 --- a/src/routes/docs/products/auth/oauth2/+page.markdoc +++ b/src/routes/docs/products/auth/oauth2/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: OAuth 2 login -description: This is the description used for SEO. +description: Integrate OAuth2 authentication seamlessly with Appwrite. Learn how to connect your application with third-party OAuth2 providers for secure user login and access. --- OAuth authentication allows users to log in using accounts from other popular services. This can be convenient for users because they can start using your app without creating a new account. It can also be more secure, because the user has one less password that could become vulnerable. diff --git a/src/routes/docs/products/auth/phone-sms/+page.markdoc b/src/routes/docs/products/auth/phone-sms/+page.markdoc index 4a5af367c7..b3f840a37f 100644 --- a/src/routes/docs/products/auth/phone-sms/+page.markdoc +++ b/src/routes/docs/products/auth/phone-sms/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Phone (SMS) login -description: This is the description used for SEO. +description: Enhance security with phone and SMS authentication in Appwrite. Discover how to add two-factor authentication via SMS, verify phone numbers, and protect user accounts. --- Phone authentication lets users create accounts using their phone numbers and log in through SMS messages. diff --git a/src/routes/docs/products/auth/quick-start/+page.markdoc b/src/routes/docs/products/auth/quick-start/+page.markdoc index b4d6b79050..596d7f66de 100644 --- a/src/routes/docs/products/auth/quick-start/+page.markdoc +++ b/src/routes/docs/products/auth/quick-start/+page.markdoc @@ -1,9 +1,7 @@ --- layout: article -title: Quick Start -description: This is the description used for SEO. -difficulty: beginner -readtime: 3 +title: Quick start +description: Effortlessly add authentication to your apps - simple signup & login in just minutes with Appwrite Authentication --- You can get up and running with Appwrite Authentication in minutes. Adding signup and login is as simple as this. diff --git a/src/routes/docs/products/auth/security/+page.markdoc b/src/routes/docs/products/auth/security/+page.markdoc index aa72045879..816101bf47 100644 --- a/src/routes/docs/products/auth/security/+page.markdoc +++ b/src/routes/docs/products/auth/security/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Security -description: This is the description used for SEO. +description: Prioritize security in your applications with Appwrite. Discover best practices, security features, and guidelines to protect user data and ensure authentication integrity. --- Appwrite provides many security features to keep both your Appwrite project and your user's information secure. diff --git a/src/routes/docs/products/auth/teams/+page.markdoc b/src/routes/docs/products/auth/teams/+page.markdoc index 79537441e6..3326326a98 100644 --- a/src/routes/docs/products/auth/teams/+page.markdoc +++ b/src/routes/docs/products/auth/teams/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article -title: User Managements -description: This is the description used for SEO. +title: Teams +description: Master team management in the Appwrite Cloud. Explore team-related functions, permissions, and more. --- Teams are a good way to allow users to share access to resources. diff --git a/src/routes/docs/products/auth/users/+page.markdoc b/src/routes/docs/products/auth/users/+page.markdoc index f967a704db..726ca1e5fc 100644 --- a/src/routes/docs/products/auth/users/+page.markdoc +++ b/src/routes/docs/products/auth/users/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Manage users -description: This is the description used for SEO. +description: Manage user identities and profiles effectively with Appwrite. Dive into user management features, account settings, and user data customization --- Appwrite Users API is used for managing users in server applications. diff --git a/src/routes/docs/products/databases/+layout.svelte b/src/routes/docs/products/databases/+layout.svelte index 432fede1ad..d37bf14100 100644 --- a/src/routes/docs/products/databases/+layout.svelte +++ b/src/routes/docs/products/databases/+layout.svelte @@ -16,7 +16,7 @@ href: '/docs/products/databases' }, { - label: 'Quick Start', + label: 'Quick start', href: '/docs/products/databases/quick-start' }, ] diff --git a/src/routes/docs/products/databases/+page.markdoc b/src/routes/docs/products/databases/+page.markdoc index 0a7428df60..082fb5f89c 100644 --- a/src/routes/docs/products/databases/+page.markdoc +++ b/src/routes/docs/products/databases/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Databases -description: This is the description used for SEO. +description: Appwrite Databases let you store and query structured data. Databases provide high-performance and scalable data storage for your key application, business, and user data. --- Appwrite Databases let you store and query structured data. diff --git a/src/routes/docs/products/databases/collections/+page.markdoc b/src/routes/docs/products/databases/collections/+page.markdoc index 78cccdb3e9..6c73a3531c 100644 --- a/src/routes/docs/products/databases/collections/+page.markdoc +++ b/src/routes/docs/products/databases/collections/+page.markdoc @@ -1,9 +1,7 @@ --- layout: article title: Collections -description: This is the description used for SEO. -difficulty: beginner -readtime: 10 +description: Organize your data with Appwrite Collections. Explore how to create and configure collections to store and structure your data effectively. --- Appwrite uses collections as containers of documents. Each collection contains many documents identical in structure. The terms collections and documents are used because the Appwrite JSON REST API resembles the API of a traditional NoSQL database. diff --git a/src/routes/docs/products/databases/databases/+page.markdoc b/src/routes/docs/products/databases/databases/+page.markdoc index 3b25157dda..fc41586800 100644 --- a/src/routes/docs/products/databases/databases/+page.markdoc +++ b/src/routes/docs/products/databases/databases/+page.markdoc @@ -1,9 +1,7 @@ --- layout: article title: Databases -description: This is the description used for SEO. -difficulty: beginner -readtime: 5 +description: Dive deeper into Appwrite Databases and their configuration. Learn how to create, manage, and optimize multiple databases for your application. --- Databases are the largest organizational unit in Appwrite. Each database contains a group [collections](/docs/products/databases/collections). diff --git a/src/routes/docs/products/databases/documents/+page.markdoc b/src/routes/docs/products/databases/documents/+page.markdoc index 9a33ecd3ad..681a142ee3 100644 --- a/src/routes/docs/products/databases/documents/+page.markdoc +++ b/src/routes/docs/products/databases/documents/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Documents -description: This is the description used for SEO. +description: Master document management with Appwrite Databases. Learn how to create, update, and query documents within your collections for dynamic data storage. --- Each piece of data or information in Appwrite Databases is a document. Documents have a structure defined by the parent collection. diff --git a/src/routes/docs/products/databases/order/+page.markdoc b/src/routes/docs/products/databases/order/+page.markdoc index 302d863f69..382ea37bb5 100644 --- a/src/routes/docs/products/databases/order/+page.markdoc +++ b/src/routes/docs/products/databases/order/+page.markdoc @@ -1,9 +1,7 @@ --- layout: article title: Order -description: This is the description used for SEO. -difficulty: intermediate -readtime: 5 +description: Understand how to do data ordering in Appwrite Databases. Learn how to order and sort your database records for efficient data retrieval." --- You can order results returned by Appwrite Databases by using an order query. diff --git a/src/routes/docs/products/databases/pagination/+page.markdoc b/src/routes/docs/products/databases/pagination/+page.markdoc index 5b0951dfd4..54c6e2b79a 100644 --- a/src/routes/docs/products/databases/pagination/+page.markdoc +++ b/src/routes/docs/products/databases/pagination/+page.markdoc @@ -1,9 +1,7 @@ --- layout: article title: Pagination -description: This is the description used for SEO. -difficulty: intermediate -readtime: 15 +description: Implement pagination for large data sets in Appwrite Databases. Explore techniques for splitting and displaying data across multiple pages. --- As your database grows in size, you'll need to paginate results returned. diff --git a/src/routes/docs/products/databases/permissions/+page.markdoc b/src/routes/docs/products/databases/permissions/+page.markdoc index 1496e46d40..de20e0acb5 100644 --- a/src/routes/docs/products/databases/permissions/+page.markdoc +++ b/src/routes/docs/products/databases/permissions/+page.markdoc @@ -1,9 +1,7 @@ --- layout: article title: Permissions -description: This is the description used for SEO. -difficulty: beginner -readtime: 5 +description: Enhance data security and access control with Appwrite Database Permissions. Learn how to set permissions and access rules for your database collections --- Permissions define who can access documents in a collection. By default **no permissions** are granted to any users, so no user can access any documents. diff --git a/src/routes/docs/products/databases/queries/+page.markdoc b/src/routes/docs/products/databases/queries/+page.markdoc index 8f393f1c32..ca56ac36c2 100644 --- a/src/routes/docs/products/databases/queries/+page.markdoc +++ b/src/routes/docs/products/databases/queries/+page.markdoc @@ -1,9 +1,7 @@ --- layout: article title: Queries -description: This is the description used for SEO. -difficulty: intermediate -readtime: 15 +description: Harness the power of querying with Appwrite Databases. Discover various query options, filtering, sorting, and advanced querying techniques. --- Many list endpoints in Appwrite allow you to filter, sort, and paginate results using queries. Appwrite provides a common set of syntax to build queries. diff --git a/src/routes/docs/products/databases/quick-start/+page.markdoc b/src/routes/docs/products/databases/quick-start/+page.markdoc index 8f337a6b70..814a4df55e 100644 --- a/src/routes/docs/products/databases/quick-start/+page.markdoc +++ b/src/routes/docs/products/databases/quick-start/+page.markdoc @@ -1,9 +1,7 @@ --- layout: article title: Quick start -description: This is the description used for SEO. -difficulty: beginner -readtime: 10 +description: Get started with Appwrite Databases. Follow a step-by-step guide to create your first database, define collections, and perform basic data operations. --- {% section #create-database step=1 title="Create database" %} diff --git a/src/routes/docs/products/databases/relationships/+page.markdoc b/src/routes/docs/products/databases/relationships/+page.markdoc index c47c1952d3..381f168728 100644 --- a/src/routes/docs/products/databases/relationships/+page.markdoc +++ b/src/routes/docs/products/databases/relationships/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Relationships -description: This is the description used for SEO. +description: Manage complex data relationships with Appwrite Databases. Discover how to define and work with relationships between documents for interconnected data. difficulty: advanced readtime: 20 --- diff --git a/src/routes/docs/products/functions/+layout.svelte b/src/routes/docs/products/functions/+layout.svelte index b960ec0941..92828f5feb 100644 --- a/src/routes/docs/products/functions/+layout.svelte +++ b/src/routes/docs/products/functions/+layout.svelte @@ -16,7 +16,7 @@ href: '/docs/products/functions' }, { - label: 'Quick Start', + label: 'Quick start', href: '/docs/products/functions/quick-start' }, ] diff --git a/src/routes/docs/products/functions/+page.markdoc b/src/routes/docs/products/functions/+page.markdoc index 2fb430dcc9..19f0ca79a0 100644 --- a/src/routes/docs/products/functions/+page.markdoc +++ b/src/routes/docs/products/functions/+page.markdoc @@ -1,9 +1,7 @@ --- layout: article title: Functions -description: [TODO] -difficulty: beginner -readtime: 3 +description: Explore the power of serverless functions with Appwrite Functions. Learn how to build and deploy serverless functions for dynamic and scalable application logic. --- Appwrite Functions unlock limitless potential for developers to extend Appwrite with code snippets. @@ -16,6 +14,11 @@ Each function will have its own URL, execute in its own isolated container, and Appwrite Functions let you build anything you can imagine, but this flexibility makes it difficult to know where to start. Start exploring by cloning one of the quick start templates or using a template with pre-built integration to quickly implement features. -[Quick start {% icon icon="cheveron-right" /%}](/docs/products/functions/quick-start) +{% only_dark %} + +{% /only_dark %} +{% only_light %} + +{% /only_light %} - \ No newline at end of file +[Quick start {% icon icon="cheveron-right" /%}](/docs/products/functions/quick-start) \ No newline at end of file diff --git a/src/routes/docs/products/functions/deployment/+page.markdoc b/src/routes/docs/products/functions/deployment/+page.markdoc index 9985627338..732d001f7d 100644 --- a/src/routes/docs/products/functions/deployment/+page.markdoc +++ b/src/routes/docs/products/functions/deployment/+page.markdoc @@ -1,9 +1,7 @@ --- layout: article title: Deployment -description: This is the description used for SEO. -difficulty: intermediate -readtime: 10 +description: Efficiently deploy your serverless functions with Appwrite. Explore deployment options, strategies, and best practices for seamless function execution. --- Appwrite Functions are mini-applications in Appwrite with their own endpoints. Each function can have many deployments, which can be thought of as versions of the mini-application. diff --git a/src/routes/docs/products/functions/development/+page.markdoc b/src/routes/docs/products/functions/development/+page.markdoc index 42a6081d7b..1a01c9ca30 100644 --- a/src/routes/docs/products/functions/development/+page.markdoc +++ b/src/routes/docs/products/functions/development/+page.markdoc @@ -1,9 +1,7 @@ --- layout: article title: Development -description: This is the description used for SEO. -difficulty: beginner -readtime: 3 +description: Master serverless function development with Appwrite. Learn how to write and test functions locally, debug code, and optimize for efficient execution. --- Appwrite Functions offer a familiar interface if you've developed REST endpoints. diff --git a/src/routes/docs/products/functions/examples/+page.markdoc b/src/routes/docs/products/functions/examples/+page.markdoc index 8048c13364..95ec8058d7 100644 --- a/src/routes/docs/products/functions/examples/+page.markdoc +++ b/src/routes/docs/products/functions/examples/+page.markdoc @@ -1,9 +1,7 @@ --- layout: article title: Examples -description: This is the description used for SEO. -difficulty: beginner -readtime: 3 +description: Accelerate your serverless development with Appwrite Functions examples. Access a library of code samples and use cases to jumpstart your projects. --- diff --git a/src/routes/docs/products/functions/execution/+page.markdoc b/src/routes/docs/products/functions/execution/+page.markdoc index 0e90e525a9..954b8afa7b 100644 --- a/src/routes/docs/products/functions/execution/+page.markdoc +++ b/src/routes/docs/products/functions/execution/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Execution -description: This is the description used for SEO. +description: Understand serverless function execution in Appwrite. Explore how triggers, events, and data flow enable dynamic execution of your code. difficulty: beginner readtime: 3 --- @@ -456,7 +456,13 @@ You test a function by hitting the **Execute now** button, which will display wi You'll be able to mock executions by configuring the path, method, headers, and body. - +{% only_dark %} + +{% /only_dark %} +{% only_light %} + +{% /only_light %} + ## Events {% #events %} diff --git a/src/routes/docs/products/functions/quick-start/+page.markdoc b/src/routes/docs/products/functions/quick-start/+page.markdoc index 18091809da..4bc64a060b 100644 --- a/src/routes/docs/products/functions/quick-start/+page.markdoc +++ b/src/routes/docs/products/functions/quick-start/+page.markdoc @@ -1,21 +1,25 @@ --- layout: article -title: Quick Start -description: This is the description used for SEO. -difficulty: beginner -readtime: 5 +title: Quick start +description: Get started quickly with Appwrite Functions. Follow a step-by-step guide to create your first serverless function, define triggers, and execute code. --- You can create and execute your first Appwrite Function in minutes. -## Create function {% #create-function %} +# Create function {% #create-function %} Before deploying your function with Git, create a new function attached to your Git repository. +{% only_dark %} + +{% /only_dark %} +{% only_light %} + +{% /only_light %} + 1. In the Appwrite Console's sidebar, click **Functions**. 2. Click **Create function**. 3. Under **Connect Git repository**, select your provider. 4. After connecting to GitHub, under **Quick start**, select a starter template. - 5. Follow the step-by-step wizard and create the function. 6. The function will be created and a build will begin. Once the build completes, you'll have created your first function. @@ -23,13 +27,21 @@ You can find the code used by the starter template in your newly created Git rep Each push to your Git repo will trigger a new deployment. ## Execute {% #execute %} +You can execute your Appwrite Function through [many different triggers](/docs/products/functions/execution). +The easiest way to execute your first function is to use the Appwrite Console. + +{% only_dark %} + +{% /only_dark %} +{% only_light %} + +{% /only_light %} 1. In the Appwrite Console's sidebar, click **Functions**. -1. Under the **Deployments** tab, click **Execute now**. +1. Under the **Executions** tab, click **Execute now**. 1. Click **Execute** to execute the starter template function. -1. You'll be redirected to the **Execution** tab automatically. 1. Wait for the execution to be marked **completed** and click to view the execution logs. - + # Explore Use this your first function as a springboard to explore the flexible and powerful features of Appwrite Functions. diff --git a/src/routes/docs/products/functions/runtimes/+page.markdoc b/src/routes/docs/products/functions/runtimes/+page.markdoc index 4e24f129c8..f357180602 100644 --- a/src/routes/docs/products/functions/runtimes/+page.markdoc +++ b/src/routes/docs/products/functions/runtimes/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Runtimes -description: +description: Choose the right runtime environment for your serverless functions in Appwrite. Explore available runtimes, dependencies, and runtime-specific considerations. --- Appwrite Functions supports an extensive list of runtimes to meet your unique tech preferences. Not all runtimes are available on Appwrite Cloud yet. Check the [Cloud Support](#cloud-support) list to know which ones are available on Appwrite Cloud. diff --git a/src/routes/docs/products/storage/+page.markdoc b/src/routes/docs/products/storage/+page.markdoc index 5218fca603..0f12cdfb67 100644 --- a/src/routes/docs/products/storage/+page.markdoc +++ b/src/routes/docs/products/storage/+page.markdoc @@ -1,9 +1,7 @@ --- layout: article title: Storage -description: This is the description used for SEO. -difficulty: beginner -readtime: 5 +description: Unlock the power of cloud storage with Appwrite Storage. Learn how to store, manage, and retrieve files and media assets securely in your applications. --- Appwrite Storage allows you to manage files in your project. diff --git a/src/routes/docs/products/storage/buckets/+page.markdoc b/src/routes/docs/products/storage/buckets/+page.markdoc index e230e7c70a..2d8f955dd6 100644 --- a/src/routes/docs/products/storage/buckets/+page.markdoc +++ b/src/routes/docs/products/storage/buckets/+page.markdoc @@ -1,9 +1,7 @@ --- layout: article title: Buckets -description: This is the description used for SEO. -difficulty: beginner -readtime: 5 +description: Organize and manage your files effectively with Appwrite Storage Buckets. Explore how to create, configure, and use storage buckets for seamless file organization. --- Storage buckets are a group of files, similar to collections in Appwrite Databases. diff --git a/src/routes/docs/products/storage/images/+page.markdoc b/src/routes/docs/products/storage/images/+page.markdoc index 65c23989f6..1134ab4808 100644 --- a/src/routes/docs/products/storage/images/+page.markdoc +++ b/src/routes/docs/products/storage/images/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Images -description: This is the description used for SEO. +description: Optimize image storage and processing with Appwrite. Explore image resizing, transformations, and manipulation to deliver rich media experiences in your apps. difficulty: beginner readtime: 15 --- diff --git a/src/routes/docs/products/storage/permissions/+page.markdoc b/src/routes/docs/products/storage/permissions/+page.markdoc index bb96f86bfc..2e6ebd44cb 100644 --- a/src/routes/docs/products/storage/permissions/+page.markdoc +++ b/src/routes/docs/products/storage/permissions/+page.markdoc @@ -1,9 +1,7 @@ --- layout: article title: Permissions -description: This is the description used for SEO. -difficulty: beginner -readtime: 5 +description: Enhance data security and control with Appwrite Storage Permissions. Learn how to set access rules, permissions, and restrictions for your stored files. --- Permissions define who can access files within a bucket. By default **no permissions** are granted to any users, so no user can access any files. diff --git a/src/routes/docs/products/storage/quick-start/+page.markdoc b/src/routes/docs/products/storage/quick-start/+page.markdoc index 1333005672..7d8b8ce9e8 100644 --- a/src/routes/docs/products/storage/quick-start/+page.markdoc +++ b/src/routes/docs/products/storage/quick-start/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article title: Quick start -description: This is the description used for SEO. +description: Get started quickly with Appwrite Storage. Follow step-by-step instructions to set up storage, upload files, and integrate cloud storage into your projects difficulty: beginner readtime: 5 --- diff --git a/src/routes/docs/products/storage/upload-download/+page.markdoc b/src/routes/docs/products/storage/upload-download/+page.markdoc index 106f5f0c0d..c4c82bb6c6 100644 --- a/src/routes/docs/products/storage/upload-download/+page.markdoc +++ b/src/routes/docs/products/storage/upload-download/+page.markdoc @@ -1,9 +1,7 @@ --- layout: article title: Upload and download -description: This is the description used for SEO. -difficulty: beginner -readtime: 15 +description: Effortlessly upload and download files with Appwrite Storage. Learn how to handle file uploads, manage file versions, and ensure secure downloads in your applications. --- You can upload and download files both programmatically using SDKs or through the Appwrite Console. diff --git a/src/routes/docs/quick-starts/+page.svelte b/src/routes/docs/quick-starts/+page.svelte index 7d08649d55..b907d97e4b 100644 --- a/src/routes/docs/quick-starts/+page.svelte +++ b/src/routes/docs/quick-starts/+page.svelte @@ -17,17 +17,23 @@ const quickStarts: QuickStarts = [ { - title: 'Web App', + title: 'Web app', quickStarts: [ { - title: 'React.js', - icon: 'icon-next_js', + title: 'Next.js', + icon: 'icon-nextjs', image: '/images/blog/placeholder.png', href: 'nextjs' }, + { + title: 'React', + icon: 'icon-react', + image: '/images/blog/placeholder.png', + href: 'react' + }, { title: 'Vue.js', - icon: 'icon-vue_js', + icon: 'icon-vue', image: '/images/blog/placeholder.png', href: 'vue' }, @@ -40,7 +46,7 @@ ] }, { - title: 'Mobile and Native', + title: 'Mobile and native', quickStarts: [ { title: 'Flutter', @@ -70,25 +76,25 @@ icon: 'icon-node', image: '/images/blog/placeholder.png', href: 'node' + }, + { + title: 'Python', + icon: 'icon-python', + image: '/images/blog/placeholder.png', + href: 'python' + }, + { + title: '.NET', + icon: 'icon-dotnet', + image: '/images/blog/placeholder.png', + href: 'dotnet' + }, + { + title: 'Dart', + icon: 'icon-dart', + image: '/images/blog/placeholder.png', + href: 'dart' } - // { - // title: 'Python', - // icon: 'icon-python', - // image: '/images/blog/placeholder.png', - // href: 'python' - // }, - // { - // title: '.NET', - // icon: 'icon-dotnet', - // image: '/images/blog/placeholder.png', - // href: 'dotnet' - // }, - // { - // title: 'Dart', - // icon: 'icon-dart', - // image: '/images/blog/placeholder.png', - // href: 'dart' - // } ] } ]; @@ -132,12 +138,11 @@
+ {{ loggedInUser ? 'Logged in as ' + loggedInUser.name : 'Not logged in' }} +
+ +Logged in as {loggedInUser.name}
+ +Not logged in
+ ++ {{ loggedInUser ? `Logged in as ${loggedInUser.name}` : 'Not logged in' }} +
+ + +- Lorem ipsum dolor sit amet consectetur. + Learn Appwrite Auth, Databases, and more with Vue.
-- Lorem ipsum dolor sit amet consectetur. + Learn Appwrite Auth, Databases, and more with SvelteKit.
-- Lorem ipsum dolor sit amet consectetur. + Coming soon...
- Lorem ipsum dolor sit amet consectetur. + Coming soon...
@@ -101,7 +101,7 @@- Lorem ipsum dolor sit amet consectetur. + Coming soon...
diff --git a/src/routes/docs/tutorials/test/+layout.svelte b/src/routes/docs/tutorials/android/+layout.svelte similarity index 100% rename from src/routes/docs/tutorials/test/+layout.svelte rename to src/routes/docs/tutorials/android/+layout.svelte diff --git a/src/routes/docs/tutorials/test/+layout.ts b/src/routes/docs/tutorials/android/+layout.ts similarity index 100% rename from src/routes/docs/tutorials/test/+layout.ts rename to src/routes/docs/tutorials/android/+layout.ts diff --git a/src/routes/docs/tutorials/test/+page.ts b/src/routes/docs/tutorials/android/+page.ts similarity index 69% rename from src/routes/docs/tutorials/test/+page.ts rename to src/routes/docs/tutorials/android/+page.ts index dadbafa938..dd64344792 100644 --- a/src/routes/docs/tutorials/test/+page.ts +++ b/src/routes/docs/tutorials/android/+page.ts @@ -2,5 +2,5 @@ import { redirect } from '@sveltejs/kit'; import type { PageLoad } from './$types'; export const load: PageLoad = async () => { - throw redirect(303, '/docs/tutorials/test/introduction'); + throw redirect(303, '/docs/tutorials/android/step-1'); }; diff --git a/src/routes/docs/tutorials/android/step-1/+page.markdoc b/src/routes/docs/tutorials/android/step-1/+page.markdoc new file mode 100644 index 0000000000..f3e111bd41 --- /dev/null +++ b/src/routes/docs/tutorials/android/step-1/+page.markdoc @@ -0,0 +1,15 @@ +--- +layout: tutorial +title: Coming soon +description: Learn to build an Android app with no backend code using an Appwrite backend. +step: 1 +--- + +Improve the docs, add this guide. + +We still don't have this guide in place, but we do have some great news. +The Appwrite docs, just like Appwrite, is completely open sourced. +This means, anyone can help improve them and add new guides and tutorials. + +If you see this page, **we're actively looking for contributions to this page**. +Follow our contribution guidelines, open a PR to [our Website repo](https://github.com/appwrite/website), and collaborate with our core team to improve this page. \ No newline at end of file diff --git a/src/routes/docs/tutorials/apple/+layout.svelte b/src/routes/docs/tutorials/apple/+layout.svelte new file mode 100644 index 0000000000..fb9fb3980f --- /dev/null +++ b/src/routes/docs/tutorials/apple/+layout.svelte @@ -0,0 +1,10 @@ + + +