From 04014446fc49c72523953c7fff1d2f539d544d29 Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Wed, 30 Aug 2023 19:05:40 +0000 Subject: [PATCH 01/17] Add github app config information --- app/views/docs/configuration.phtml | 70 +++++++++++++++++++++++++++++- 1 file changed, 69 insertions(+), 1 deletion(-) diff --git a/app/views/docs/configuration.phtml b/app/views/docs/configuration.phtml index 9a0fc31f..3f5fbfdc 100644 --- a/app/views/docs/configuration.phtml +++ b/app/views/docs/configuration.phtml @@ -23,9 +23,77 @@

Appwrite supports automatic deployments through Git integration. In order for Appwrite to access your repos, you must configure a GitHub app to enable this integration. + The GitHub app requires the following permissions。

-

You'll have to configure the following environment variables.

+

Repository permissions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PermissionAccess
AdministrationRead and write
ChecksRead and write.
ContentsRead and write
IssuesRead and write
Pull requestsRead and write
WebhooksRead and write
+ +

Subscribe to events

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Event
Meta
Issue comment
Issues
Pull request
Push
Respository
+ +

After creating your app, you'll have to configure the following environment variables.

From b14f78b12355c2a0b37e155fd434564522d93241 Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Thu, 31 Aug 2023 00:11:47 +0000 Subject: [PATCH 02/17] Hack more closely packed rows --- app/views/docs/configuration.phtml | 18 ++++-------------- 1 file changed, 4 insertions(+), 14 deletions(-) diff --git a/app/views/docs/configuration.phtml b/app/views/docs/configuration.phtml index 3f5fbfdc..13070932 100644 --- a/app/views/docs/configuration.phtml +++ b/app/views/docs/configuration.phtml @@ -69,26 +69,16 @@ + + - + - - - - - - - - - - - - - +
Event
MetaMeta Issue comment Issues
Issue comment
Issues
Pull request
Push
RespositoryPull request Push Respository
From 96eb0896d7790daa3e761d108d2e3a28477e593a Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Thu, 31 Aug 2023 00:43:28 +0000 Subject: [PATCH 03/17] fixes some links --- app/views/docs/authentication-management.phtml | 2 +- app/views/docs/functions-deploy.phtml | 2 +- app/views/docs/functions-develop.phtml | 12 ++++++------ 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/app/views/docs/authentication-management.phtml b/app/views/docs/authentication-management.phtml index e9a08391..1a17c86d 100644 --- a/app/views/docs/authentication-management.phtml +++ b/app/views/docs/authentication-management.phtml @@ -414,7 +414,7 @@ var response = await users.UpdateLabels(

- For example, in a todo app, a user can create a team for one of their todo lists and invite another user to the team to grant the other user access. + For example, in a todo app, a user can create a team for one of their todo lists and invite another user to the team to grant the other user access. The invited user can accept the invitation to gain access. If the user's ever removed from the team, they'll lose access again.

diff --git a/app/views/docs/functions-deploy.phtml b/app/views/docs/functions-deploy.phtml index 934166ed..d17948fa 100644 --- a/app/views/docs/functions-deploy.phtml +++ b/app/views/docs/functions-deploy.phtml @@ -71,7 +71,7 @@

CLI

CLI Setup

-

Before you can deploy with the Appwrite CLI, make sure you've installed and initialized the CLI.

+

Before you can deploy with the Appwrite CLI, make sure you've installed and initialized the CLI.

To deploy with the Appwrite CLI, your function must be added to appwrite.json that tells the CLI where each function is stored. diff --git a/app/views/docs/functions-develop.phtml b/app/views/docs/functions-develop.phtml index 39617c17..74272e38 100644 --- a/app/views/docs/functions-develop.phtml +++ b/app/views/docs/functions-develop.phtml @@ -2637,32 +2637,32 @@ public class Main {

  • The parameter passed into functions has changed. req and res has been replaced by context, which contains new logger methods. - Learn about context. + Learn about context.
  • To improve privacy and logging reliability, we provide new context.log() and context.error() functions. You can no longer use native logging methods. - Learn about logging. + Learn about logging.
  • The old way of req.variables has been deprecated. You can now access variables passed into each function as environment variables. - Learn about environment variables. + Learn about environment variables.
  • The req object has been updated to use terminology consistent with typical HTTP concepts. You'll now find familiar concepts like headers, body, HTTP methods, and others. - Learn about request. + Learn about request.
  • The response object has been updated. You can now specify headers, as well as use new methods like return redirects or empty responses. - Learn about response. + Learn about response.
  • Now, you must return a response such as return context.res.send(""). This prevents confusing errors when functions are terminated prematurely before a response is sent. - Learn about response. + Learn about response.
  • Some variables about how a function was triggered are now found in the context.req object as headers. From 24ab17a5163b2b9fa47d4bc7155c0765720e9e9d Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Thu, 31 Aug 2023 02:11:34 +0000 Subject: [PATCH 04/17] Fix some bits missed in the firebase docs --- app/views/docs/migrations-firebase.phtml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/app/views/docs/migrations-firebase.phtml b/app/views/docs/migrations-firebase.phtml index 2c351d59..78f7bb87 100644 --- a/app/views/docs/migrations-firebase.phtml +++ b/app/views/docs/migrations-firebase.phtml @@ -143,12 +143,13 @@ Click Add Key and select Create new key. Select JSON as the key type and click Create. This will download a JSON file to your computer.
  • - Upload the JSON file to Appwrite and follow the migration wizard. + Upload the JSON file to Appwrite and follow the migration wizard to select which resource you need to migrate.
  • - After completing the migration wizard, migration will begin. Return to step 4 of the migration steps. + After completing the migration wizard, migration will begin. This will run in the background, you can close the browser..
  • - Finally, add the platforms for your Web, Flutter, Android, and iOS apps. + Finally, add the platforms for your Web, Flutter, Android, and iOS apps. + Also remember to add appropriate permissions to the migrated resources to protect user data and privacy.
    • \ No newline at end of file From f27bebba181f04b3fb6e5ee2c77c5b737aa113f5 Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Thu, 31 Aug 2023 15:45:15 +0000 Subject: [PATCH 05/17] Add steps for configuration --- app/views/docs/configuration.phtml | 64 +++++++++++++++++++++++++++--- 1 file changed, 59 insertions(+), 5 deletions(-) diff --git a/app/views/docs/configuration.phtml b/app/views/docs/configuration.phtml index 13070932..55529c5e 100644 --- a/app/views/docs/configuration.phtml +++ b/app/views/docs/configuration.phtml @@ -23,9 +23,38 @@

    Appwrite supports automatic deployments through Git integration. In order for Appwrite to access your repos, you must configure a GitHub app to enable this integration. - The GitHub app requires the following permissions。 + The GitHub app requires the following configurations.

    +

    + For automatic Git deployment to work, Appwrite needs to receive communication from GitHub, this means your Appwrite project must be accessible on the internet. + If you're running on localhost, you need to run a proxy like ngrok. +

    + +

    Callback URLs

    +

    + GitHub will use callback URLs to communicate with Appwrite. + Set these callback URLs under Identifying and authorizing users. +

    + + + + + + + + + + + + + + +
    URLs
    http://[HOSTNAME_OR_IP]/v1/vcs/github/callback
    http://[HOSTNAME_OR_IP]/v1/account/sessions/oauth2/callback/github/console
    + +

    Post installation

    +

    Check the Redirect on update box under the Post installation section.

    +

    Repository permissions

    @@ -44,6 +73,10 @@ + + + + @@ -52,6 +85,10 @@ + + + + @@ -63,6 +100,24 @@
    Checks Read and write.
    Commit StatusesRead and write
    Contents Read and writeIssues Read and write
    MetadataRead-only
    Pull requests Read and write
    +

    Account permissions

    + + + + + + + + + + + + + + +
    PermissionAccess
    Email addressRead-only
    + +

    Subscribe to events

    @@ -75,10 +130,7 @@ - - - - +
    Meta Issue comment Issues
    Pull request Push RespositoryPull request Push
    @@ -120,6 +172,8 @@ + +

    Learn more about environment variables

    Configure Function Runtimes

    From 7093dceddc079556a2f58ccb9c4a52313cee8859 Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Thu, 31 Aug 2023 18:01:04 +0000 Subject: [PATCH 06/17] update github config instruction styling --- app/views/docs/configuration.phtml | 38 +++++++++++--------- app/views/docs/email-and-sms-templates.phtml | 2 +- 2 files changed, 23 insertions(+), 17 deletions(-) diff --git a/app/views/docs/configuration.phtml b/app/views/docs/configuration.phtml index 55529c5e..151919e3 100644 --- a/app/views/docs/configuration.phtml +++ b/app/views/docs/configuration.phtml @@ -22,7 +22,7 @@

    Configure GitHub App

    Appwrite supports automatic deployments through Git integration. - In order for Appwrite to access your repos, you must configure a GitHub app to enable this integration. + In order for Appwrite to access your repos, you must create a GitHub app to enable this integration. The GitHub app requires the following configurations.

    @@ -31,7 +31,7 @@ If you're running on localhost, you need to run a proxy like ngrok.

    -

    Callback URLs

    +

    Callback URL

    GitHub will use callback URLs to communicate with Appwrite. Set these callback URLs under Identifying and authorizing users. @@ -44,19 +44,23 @@ - http://[HOSTNAME_OR_IP]/v1/vcs/github/callback + http://[HOSTNAME_OR_IP]/v1/vcs/github/callback - http://[HOSTNAME_OR_IP]/v1/account/sessions/oauth2/callback/github/console + http://[HOSTNAME_OR_IP]/v1/account/sessions/oauth2/callback/github/console -

    Post installation

    -

    Check the Redirect on update box under the Post installation section.

    - -

    Repository permissions

    +

    Post Installation

    +

    + Check the Redirect on update box under the Post installation section. +

    +

    Repository Permissions

    +

    + Configure these permissions under the Repository permission dropdown. +

    @@ -100,8 +104,10 @@
    -

    Account permissions

    - +

    Account Permissions

    +

    + Configure these permissions under the Account Permission dropdown. +

    @@ -117,9 +123,10 @@
    - -

    Subscribe to events

    - +

    Subscribe to Events

    +

    + Select these under the Subscribe to events dropdown. +

    @@ -135,6 +142,7 @@
    +

    Environment Variables

    After creating your app, you'll have to configure the following environment variables.

    @@ -147,7 +155,7 @@ - + @@ -172,8 +180,6 @@
    _APP_VCS_GITHUB_APP_NAMEName of your GitHub app. This value should be set to your GitHub application's URL.Name of your GitHub app. This is the display name you'll see on GitHub and it will be visible in your GitHub app's URL.
    _APP_VCS_GITHUB_PRIVATE_KEY
    - -

    Learn more about environment variables

    Configure Function Runtimes

    diff --git a/app/views/docs/email-and-sms-templates.phtml b/app/views/docs/email-and-sms-templates.phtml index e685405f..f7ad0fc5 100644 --- a/app/views/docs/email-and-sms-templates.phtml +++ b/app/views/docs/email-and-sms-templates.phtml @@ -6,7 +6,7 @@ depending on the configured locale.

    -

    Custom SMTP server

    +

    Custom SMTP server

    Appwrite Cloud has a default SMTP server to get you started. This SMTP server sends generic emails and doesn't allow customizing SMTP templates. From e332cef9480179c5e3a8fe6a11307945e8ff57bc Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Thu, 31 Aug 2023 18:10:58 +0000 Subject: [PATCH 07/17] Fix some spelling errors --- app/views/docs/configuration.phtml | 10 +++++----- app/views/docs/self-hosting.phtml | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/app/views/docs/configuration.phtml b/app/views/docs/configuration.phtml index 151919e3..c1c98365 100644 --- a/app/views/docs/configuration.phtml +++ b/app/views/docs/configuration.phtml @@ -198,18 +198,18 @@

    You can find a full list of supported runtimes on the environment variables page.

    -

    You can also configure the maximum timeout that can be set on individual Appwrite functions. The maximum configurable timeout can be increased by changing the _APP_FUNCTIONS_TIMEOUT environment variable. This environment variable changes the configurable maximum but does not alter existing individual configurations.

    +

    You can also configure the maximum timeout that can be set on individual Appwrite functions. The maximum configurable timeout can be increased by changing the _APP_FUNCTIONS_TIMEOUT environment variable. This environment variable changes the configurable maximum but does not alter existing configurations of individual functions.

    -

    Storage Adaptors

    +

    Storage Adapters

    Appwrite's Storage Service can be configured to store files locally, or with self-hosted and cloud storage services. By default, Appwrite's Storage Service stores files on your server's local storage. If you expect large volumes of data or the need to have scalable data storage, you may choose to use a separate storage service.

    -

    Appwrite supports AWS S3, Digital Ocean Spaces, Backblaze, Akamai Object Storage, and Wasabi as storage adaptors. Some of these services can be self-hosted, just like Appwrite.

    +

    Appwrite supports AWS S3, Digital Ocean Spaces, Backblaze, Akamai Object Storage, and Wasabi as storage adapters. Some of these services can be self-hosted, just like Appwrite.

    -

    You can select which storage adaptor to use by setting the _APP_STORAGE_DEVICE environment variable. Valid values are local, s3, dospaces, backblaze, linode and wasabi. Each storage adaptor requires its own set of additional environment variables to configure.

    +

    You can select which storage adaptor to use by setting the _APP_STORAGE_DEVICE environment variable. Valid values are local, s3, dospaces, backblaze, linode, and wasabi. Each storage adaptor requires its own set of additional environment variables to configure.

    The maximum size for individual file uploads is controlled by the _APP_STORAGE_LIMIT environment variable, which defaults to 30 MB. See Environment Variables for more information.

    -

    Configure storage adaptors

    +

    Configure storage adapters

    Applying Changes

    After editing your docker-compose.yml or .env files, you will need to recreate your Appwrite stack by running the following compose command in your terminal.

    diff --git a/app/views/docs/self-hosting.phtml b/app/views/docs/self-hosting.phtml index 2f6c39fd..3a110d77 100644 --- a/app/views/docs/self-hosting.phtml +++ b/app/views/docs/self-hosting.phtml @@ -121,7 +121,7 @@

    Next Steps

    -

    Self-hosting Appwrite gives you more configurable options. You can customize Appwrite with your choice of S3 compatible storage adaptors, email and SMS providers, functions runtimes, and more.

    +

    Self-hosting Appwrite gives you more configurable options. You can customize Appwrite with your choice of S3 compatible storage adapters, email and SMS providers, functions runtimes, and more.

    Learn about configuring Appwrite

    From eab646c8782ba0ecf1941d92bb26295e4429a9ba Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Thu, 31 Aug 2023 18:57:50 +0000 Subject: [PATCH 08/17] add comments about using ngrok or another proxy --- app/views/docs/authentication-management.phtml | 2 +- app/views/docs/configuration.phtml | 16 +++++++++++++++- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/app/views/docs/authentication-management.phtml b/app/views/docs/authentication-management.phtml index 1a17c86d..f5790bf5 100644 --- a/app/views/docs/authentication-management.phtml +++ b/app/views/docs/authentication-management.phtml @@ -204,7 +204,7 @@ let prefs = try await account.getPrefs()

    Labels

    - Labels are a good way to flag a user to grant them access to resources. + 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/app/views/docs/configuration.phtml b/app/views/docs/configuration.phtml index c1c98365..4a2d8439 100644 --- a/app/views/docs/configuration.phtml +++ b/app/views/docs/configuration.phtml @@ -33,7 +33,7 @@

    Callback URL

    - GitHub will use callback URLs to communicate with Appwrite. + GitHub will use callback URLs to redirect users back to Appwrite. Set these callback URLs under Identifying and authorizing users.

    @@ -57,6 +57,19 @@ Check the Redirect on update box under the Post installation section.

    + +

    Webhook

    +

    + GitHub will notify Appwrite about events like new commits using webhooks. + Under Webhook, you need to check the Active checkbox. + You also need to set the Webhook URL as https://[HOSTNAME_OR_IP]/v1/vcs/github/events. +

    + +

    + If you're running Appwrite on localhost, GitHub can't send requests to Appwrite through webhooks and automatic deployments won't work. + You'll need host Appwrite on a server or use a proxy like ngrok to make Appwrite accessible to GitHub. +

    +

    Repository Permissions

    Configure these permissions under the Repository permission dropdown. @@ -182,6 +195,7 @@

    Learn more about environment variables

    +

    Configure Function Runtimes

    Not all function runtimes are enabled by default. Enable the runtimes that you need and disable unused runtimes to save disk space on your server. From 3fc771866869bb3b23cb08b60cc3df054396cbd7 Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Thu, 31 Aug 2023 14:58:46 -0400 Subject: [PATCH 09/17] Update app/views/docs/configuration.phtml Co-authored-by: Steven Nguyen <1477010+stnguyen90@users.noreply.github.com> --- app/views/docs/configuration.phtml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/app/views/docs/configuration.phtml b/app/views/docs/configuration.phtml index 4a2d8439..568850e4 100644 --- a/app/views/docs/configuration.phtml +++ b/app/views/docs/configuration.phtml @@ -38,17 +38,17 @@

    - - - + + + - - - - - - + + + + + +
    URLs
    URLs
    http://[HOSTNAME_OR_IP]/v1/vcs/github/callback
    http://[HOSTNAME_OR_IP]/v1/account/sessions/oauth2/callback/github/console
    http://[HOSTNAME_OR_IP]/v1/vcs/github/callback
    http://[HOSTNAME_OR_IP]/v1/account/sessions/oauth2/callback/github/console
    From 3955c3f167347994bc4259863783c4cec4cd47d7 Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Thu, 31 Aug 2023 14:59:50 -0400 Subject: [PATCH 10/17] Apply suggestions from code review Co-authored-by: Steven Nguyen <1477010+stnguyen90@users.noreply.github.com> --- app/views/docs/configuration.phtml | 106 +++++++++++++------------ app/views/docs/functions-develop.phtml | 2 +- 2 files changed, 55 insertions(+), 53 deletions(-) diff --git a/app/views/docs/configuration.phtml b/app/views/docs/configuration.phtml index 568850e4..c589a165 100644 --- a/app/views/docs/configuration.phtml +++ b/app/views/docs/configuration.phtml @@ -54,7 +54,7 @@

    Post Installation

    - Check the Redirect on update box under the Post installation section. + Check the Redirect on update box under the Post installation section.

    @@ -76,44 +76,44 @@

    - - - - + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    PermissionAccess
    PermissionAccess
    AdministrationRead and write
    ChecksRead and write.
    Commit StatusesRead and write
    ContentsRead and write
    IssuesRead and write
    MetadataRead-only
    Pull requestsRead and write
    WebhooksRead and write
    AdministrationRead and write
    ChecksRead and write.
    Commit StatusesRead and write
    ContentsRead and write
    IssuesRead and write
    MetadataRead-only
    Pull requestsRead and write
    WebhooksRead and write
    @@ -123,15 +123,15 @@

    - - - - + + + + - - - + + +
    PermissionAccess
    PermissionAccess
    Email addressRead-only
    Email addressRead-only
    @@ -142,16 +142,18 @@

    - - - - - + + + + + - - - + + + + +
    Event
    Event
    Pull request Push
    Pull requestPush
    diff --git a/app/views/docs/functions-develop.phtml b/app/views/docs/functions-develop.phtml index 74272e38..20c78e1d 100644 --- a/app/views/docs/functions-develop.phtml +++ b/app/views/docs/functions-develop.phtml @@ -2662,7 +2662,7 @@ public class Main {
  • Now, you must return a response such as return context.res.send(""). This prevents confusing errors when functions are terminated prematurely before a response is sent. - Learn about response. + Learn about response.
  • Some variables about how a function was triggered are now found in the context.req object as headers. From d848ac853f56e902b1d855a988da2f5c15fb5952 Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Thu, 31 Aug 2023 19:16:41 +0000 Subject: [PATCH 11/17] add a section about existing apps --- app/views/docs/configuration.phtml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/app/views/docs/configuration.phtml b/app/views/docs/configuration.phtml index c589a165..4bc3b37e 100644 --- a/app/views/docs/configuration.phtml +++ b/app/views/docs/configuration.phtml @@ -197,6 +197,13 @@

    Learn more about environment variables

    +

    Update Existing GitHub Apps

    +

    + If you're editing existing GitHub apps, there are additional steps. + Everytime you update your GitHub app's setting, GitHub will prompt you to review the changes. + You will receive an email and you'll find a prompt under Settings > Integrations > Applications > Installed GitHub Apps > find your GitHub app > Configure. + You need accept the change so they're applied to your app. +

    Configure Function Runtimes

    From 0a93ad68f035b388f1c9372cea02ef7ec94ac1c0 Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Thu, 31 Aug 2023 15:21:58 -0400 Subject: [PATCH 12/17] Update app/views/docs/configuration.phtml --- app/views/docs/configuration.phtml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/views/docs/configuration.phtml b/app/views/docs/configuration.phtml index 4bc3b37e..a8db316c 100644 --- a/app/views/docs/configuration.phtml +++ b/app/views/docs/configuration.phtml @@ -200,7 +200,7 @@

    Update Existing GitHub Apps

    If you're editing existing GitHub apps, there are additional steps. - Everytime you update your GitHub app's setting, GitHub will prompt you to review the changes. + Every time you update your GitHub app's permissions, GitHub will prompt you to review the changes. You will receive an email and you'll find a prompt under Settings > Integrations > Applications > Installed GitHub Apps > find your GitHub app > Configure. You need accept the change so they're applied to your app.

    From 6c37c355553d48bffc07721058925f9728fe2ba9 Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Thu, 31 Aug 2023 15:24:02 -0400 Subject: [PATCH 13/17] Update app/views/docs/configuration.phtml --- app/views/docs/configuration.phtml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/views/docs/configuration.phtml b/app/views/docs/configuration.phtml index a8db316c..3372ef43 100644 --- a/app/views/docs/configuration.phtml +++ b/app/views/docs/configuration.phtml @@ -199,7 +199,7 @@

    Update Existing GitHub Apps

    - If you're editing existing GitHub apps, there are additional steps. + There are additional steps if you're updating permissions in existing GitHub apps. Every time you update your GitHub app's permissions, GitHub will prompt you to review the changes. You will receive an email and you'll find a prompt under Settings > Integrations > Applications > Installed GitHub Apps > find your GitHub app > Configure. You need accept the change so they're applied to your app. From be0e83b6fa117cd589a9b81e9cc6f7cdef69c2de Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Thu, 31 Aug 2023 15:24:07 -0400 Subject: [PATCH 14/17] Update app/views/docs/configuration.phtml --- app/views/docs/configuration.phtml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/views/docs/configuration.phtml b/app/views/docs/configuration.phtml index 3372ef43..07ef5c6e 100644 --- a/app/views/docs/configuration.phtml +++ b/app/views/docs/configuration.phtml @@ -202,7 +202,7 @@ There are additional steps if you're updating permissions in existing GitHub apps. Every time you update your GitHub app's permissions, GitHub will prompt you to review the changes. You will receive an email and you'll find a prompt under Settings > Integrations > Applications > Installed GitHub Apps > find your GitHub app > Configure. - You need accept the change so they're applied to your app. + You need to accept the new permissions so they're applied to your app.

    Configure Function Runtimes

    From 7948cdfaa3d57b768422461cca734d00f31ec359 Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Thu, 31 Aug 2023 20:09:18 +0000 Subject: [PATCH 15/17] Hyperlink ngrok --- app/views/docs/configuration.phtml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/app/views/docs/configuration.phtml b/app/views/docs/configuration.phtml index 07ef5c6e..4fa78a48 100644 --- a/app/views/docs/configuration.phtml +++ b/app/views/docs/configuration.phtml @@ -28,7 +28,7 @@

    For automatic Git deployment to work, Appwrite needs to receive communication from GitHub, this means your Appwrite project must be accessible on the internet. - If you're running on localhost, you need to run a proxy like ngrok. + If you're running on localhost, you need to run a proxy like ngrok.

    Callback URL

    @@ -67,7 +67,7 @@

    If you're running Appwrite on localhost, GitHub can't send requests to Appwrite through webhooks and automatic deployments won't work. - You'll need host Appwrite on a server or use a proxy like ngrok to make Appwrite accessible to GitHub. + You'll need host Appwrite on a server or use a proxy like ngrok to make Appwrite accessible to GitHub.

    Repository Permissions

    From 35c58f0291761bf94fab706472b18f89505a5799 Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Thu, 31 Aug 2023 16:24:52 -0400 Subject: [PATCH 16/17] Update app/views/docs/configuration.phtml Co-authored-by: Christy Jacob --- app/views/docs/configuration.phtml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/views/docs/configuration.phtml b/app/views/docs/configuration.phtml index 4fa78a48..d9c1817d 100644 --- a/app/views/docs/configuration.phtml +++ b/app/views/docs/configuration.phtml @@ -228,7 +228,7 @@

    Appwrite supports AWS S3, Digital Ocean Spaces, Backblaze, Akamai Object Storage, and Wasabi as storage adapters. Some of these services can be self-hosted, just like Appwrite.

    -

    You can select which storage adaptor to use by setting the _APP_STORAGE_DEVICE environment variable. Valid values are local, s3, dospaces, backblaze, linode, and wasabi. Each storage adaptor requires its own set of additional environment variables to configure.

    +

    You can select which storage adapter to use by setting the _APP_STORAGE_DEVICE environment variable. Valid values are local, s3, dospaces, backblaze, linode, and wasabi. Each storage adapter requires its own set of additional environment variables to configure.

    The maximum size for individual file uploads is controlled by the _APP_STORAGE_LIMIT environment variable, which defaults to 30 MB. See Environment Variables for more information.

    From 8e8153fd921043d639c7d70f9fd10cd82fbc875f Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Thu, 31 Aug 2023 20:25:56 +0000 Subject: [PATCH 17/17] Adaptor -> Adapter miss spelt --- app/views/docs/databases.phtml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/views/docs/databases.phtml b/app/views/docs/databases.phtml index a6a8698a..70556884 100644 --- a/app/views/docs/databases.phtml +++ b/app/views/docs/databases.phtml @@ -11,7 +11,7 @@

    Create Your Databases

    - Appwrite's Databases Service allows you to create multiple databases. Each database can contain many collections and can be backed by a different database adaptor in future versions. + Appwrite's Databases Service allows you to create multiple databases. Each database can contain many collections and can be backed by a different database adapter in future versions.