From 5424531b85e0c609c87a99caa085eab35de91fb9 Mon Sep 17 00:00:00 2001 From: Sayanta Banerjee <53281158+Sayanta66@users.noreply.github.com> Date: Wed, 22 Sep 2021 16:25:09 +0530 Subject: [PATCH 1/6] Copyedited the tutorial Copyedited the tutorial. Fixed all of the document errors and punctuation errors along with typos --- docs/tutorials/add-environment-variable.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/tutorials/add-environment-variable.md b/docs/tutorials/add-environment-variable.md index c88eb585dc..c9ed2ee3ad 100644 --- a/docs/tutorials/add-environment-variable.md +++ b/docs/tutorials/add-environment-variable.md @@ -1,32 +1,32 @@ # Introducing new Environment Variable -This document is part of the Appwrite contributors' guide. Before you continue reading this document make sure you have read the [Code of Conduct](https://github.com/appwrite/appwrite/blob/master/CODE_OF_CONDUCT.md) and the [Contributing Guide](https://github.com/appwrite/appwrite/blob/master/CONTRIBUTING.md). +This document is part of the Appwrite contributors' guide. Before you continue reading this document, make sure you have read the [Code of Conduct](https://github.com/appwrite/appwrite/blob/master/CODE_OF_CONDUCT.md) and the [Contributing Guide](https://github.com/appwrite/appwrite/blob/master/CONTRIBUTING.md). ## Getting Started ### Agenda -Adding new features may require various configurations options to be set by the users. And for such options we use environment variables in Appwrite. +Adding new features may require various configurations options to be set by the users. And for such options, we use environment variables in Appwrite. -This tutorial will cover, how to properly add a new environment variable in Appwrite. +This tutorial will cover how to properly add a new environment variable in Appwrite. ### Naming environment varialbe -The environment variables in Appwrite are prefixed with `_APP_`. If it belongs to a specific category, the category name is appended as `_APP_REDIS` for the redis category. The available categories are General, Redis, MariaDB, InfluxDB, StatsD, SMTP, Storage and Functions. Finally a properly describing name is given to the variable. For example `_APP_REDIS_HOST` is an environment variable for redis connection host. You can find more information on available categories and existing environment variables in the [environment variables doc](https://appwrite.io/docs/environment-variables). +The environment variables in Appwrite are prefixed with `_APP_`. If it belongs to a specific category, the category name is appended as `_APP_REDIS` for the Redis category. The available categories are General, Redis, MariaDB, InfluxDB, StatsD, SMTP, Storage and Functions. Finally, a properly describing name is given to the variable. For example, `_APP_REDIS_HOST` is an environment variable for Redis connection host. You can find more information on available categories and existing environment variables in the [environment variables doc](https://appwrite.io/docs/environment-variables). ### Describe new environment variable -First of all, we add the new environment variable to `app/config/variables.php` in the designated category. If none of the categories fit, add it to the General category. Copy the existing variables description to create a new one, so that you will not miss any required fields. +First of all, we added the new environment variable to `app/config/variables.php` in the designated category. If none of the categories fit, add it to the General category. Copy the description of the existing variable to create a new one so that you will not miss any required fields. This information is also used to generate the website documentation at https://appwrite.io/docs/environment-variables, so please use good descriptions that clearly define the purpose and other required info about the environment variable that you are adding. ### Add to .env and Dockerfile -If newly introduced environment variable has a default value, add it to the `.env` and `Dockerfile` along with other environment variables. `.env` file uses settings for Appwrite development environment. +If the newly introduced environment variable has a default value, add it to the `.env` and `Dockerfile` along with other environment variables. `.env` file uses settings for Appwrite development environment. -### Add to docker compose file and template -Add the new environment variables to the `docker-compose.yml` and `app/views/install/compose.phtml` for each docker services that require access to those environment variables. +### Add to docker-compose file and template +Add the new environment variables to the `docker-compose.yml` and `app/views/install/compose.phtml` for each docker service that requires access to those environment variables. -The `docker-compose.yml` file is used by the Appwrite maintainers during development where as `app/views/install/compose.phtml` file is used by the Appwrite setup script. +The Appwrite maintainers use the `docker-compose.yml` file during development, whereas the `app/views/install/compose.phtml` file is used by the Appwrite setup script. With these steps, your environment variable is properly added and can be accessed inside Appwrite code and any other containers where it is passed. You can access and use those variables to implement the features you are trying to achieve. If everything went well, commit and initiate a PR and wait for the Appwrite team's approval. -Whooho! you have successfully added new environment variable to Appwrite. 🎉 +Whooho! You have successfully added the new environment variable to Appwrite. 🎉 From 77d0010c9aa9ef7e3f6b65e34b8c7fc0fb41ad6d Mon Sep 17 00:00:00 2001 From: Sayanta Banerjee <53281158+Sayanta66@users.noreply.github.com> Date: Mon, 27 Sep 2021 20:14:27 +0530 Subject: [PATCH 2/6] Update add-environment-variable.md --- docs/tutorials/add-environment-variable.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials/add-environment-variable.md b/docs/tutorials/add-environment-variable.md index c9ed2ee3ad..3bfbdc9c60 100644 --- a/docs/tutorials/add-environment-variable.md +++ b/docs/tutorials/add-environment-variable.md @@ -29,4 +29,4 @@ With these steps, your environment variable is properly added and can be accesse If everything went well, commit and initiate a PR and wait for the Appwrite team's approval. -Whooho! You have successfully added the new environment variable to Appwrite. 🎉 +Whooho! You have successfully added a new environment variable to Appwrite. 🎉 From 4542b7572a738139fc4c8bd7c43ccc5e83ac6da6 Mon Sep 17 00:00:00 2001 From: Sayanta Banerjee <53281158+Sayanta66@users.noreply.github.com> Date: Mon, 27 Sep 2021 20:16:19 +0530 Subject: [PATCH 3/6] Update add-environment-variable.md --- docs/tutorials/add-environment-variable.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials/add-environment-variable.md b/docs/tutorials/add-environment-variable.md index 3bfbdc9c60..8e0e5e29cc 100644 --- a/docs/tutorials/add-environment-variable.md +++ b/docs/tutorials/add-environment-variable.md @@ -23,7 +23,7 @@ If the newly introduced environment variable has a default value, add it to the ### Add to docker-compose file and template Add the new environment variables to the `docker-compose.yml` and `app/views/install/compose.phtml` for each docker service that requires access to those environment variables. -The Appwrite maintainers use the `docker-compose.yml` file during development, whereas the `app/views/install/compose.phtml` file is used by the Appwrite setup script. +The docker-compose.yml file is used by the Appwrite maintainers during development, whereas the `app/views/install/compose.phtml` file is used by the Appwrite setup script. With these steps, your environment variable is properly added and can be accessed inside Appwrite code and any other containers where it is passed. You can access and use those variables to implement the features you are trying to achieve. From 3d6c8e3d9a0708dbd84a16133d3313f00cf4757f Mon Sep 17 00:00:00 2001 From: Sayanta Banerjee <53281158+Sayanta66@users.noreply.github.com> Date: Mon, 27 Sep 2021 20:21:19 +0530 Subject: [PATCH 4/6] Update add-environment-variable.md --- docs/tutorials/add-environment-variable.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/tutorials/add-environment-variable.md b/docs/tutorials/add-environment-variable.md index 8e0e5e29cc..917e90bb31 100644 --- a/docs/tutorials/add-environment-variable.md +++ b/docs/tutorials/add-environment-variable.md @@ -13,17 +13,17 @@ This tutorial will cover how to properly add a new environment variable in Appwr The environment variables in Appwrite are prefixed with `_APP_`. If it belongs to a specific category, the category name is appended as `_APP_REDIS` for the Redis category. The available categories are General, Redis, MariaDB, InfluxDB, StatsD, SMTP, Storage and Functions. Finally, a properly describing name is given to the variable. For example, `_APP_REDIS_HOST` is an environment variable for Redis connection host. You can find more information on available categories and existing environment variables in the [environment variables doc](https://appwrite.io/docs/environment-variables). ### Describe new environment variable -First of all, we added the new environment variable to `app/config/variables.php` in the designated category. If none of the categories fit, add it to the General category. Copy the description of the existing variable to create a new one so that you will not miss any required fields. +First of all, we added the new environment variable to `app/config/variables.php` in the designated category. If none of the categories fit, add it to the General category. Copy the existing variable description to create a new one so that you will not miss any required fields. This information is also used to generate the website documentation at https://appwrite.io/docs/environment-variables, so please use good descriptions that clearly define the purpose and other required info about the environment variable that you are adding. ### Add to .env and Dockerfile If the newly introduced environment variable has a default value, add it to the `.env` and `Dockerfile` along with other environment variables. `.env` file uses settings for Appwrite development environment. -### Add to docker-compose file and template +### Add to Docker Compose file and template Add the new environment variables to the `docker-compose.yml` and `app/views/install/compose.phtml` for each docker service that requires access to those environment variables. -The docker-compose.yml file is used by the Appwrite maintainers during development, whereas the `app/views/install/compose.phtml` file is used by the Appwrite setup script. +The `docker-compose.yml` file is used by the Appwrite maintainers during development, whereas the `app/views/install/compose.phtml` file is used by the Appwrite setup script. With these steps, your environment variable is properly added and can be accessed inside Appwrite code and any other containers where it is passed. You can access and use those variables to implement the features you are trying to achieve. From dab5aadc9a625107925ab4c9d4f06b863af08548 Mon Sep 17 00:00:00 2001 From: Sayanta Banerjee <53281158+Sayanta66@users.noreply.github.com> Date: Mon, 17 Jan 2022 19:54:46 +0530 Subject: [PATCH 5/6] Update docs/tutorials/add-environment-variable.md Co-authored-by: Aditya Oberai <31401437+adityaoberai@users.noreply.github.com> --- docs/tutorials/add-environment-variable.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials/add-environment-variable.md b/docs/tutorials/add-environment-variable.md index 917e90bb31..a9c4597071 100644 --- a/docs/tutorials/add-environment-variable.md +++ b/docs/tutorials/add-environment-variable.md @@ -9,7 +9,7 @@ Adding new features may require various configurations options to be set by the This tutorial will cover how to properly add a new environment variable in Appwrite. -### Naming environment varialbe +### Naming environment variable The environment variables in Appwrite are prefixed with `_APP_`. If it belongs to a specific category, the category name is appended as `_APP_REDIS` for the Redis category. The available categories are General, Redis, MariaDB, InfluxDB, StatsD, SMTP, Storage and Functions. Finally, a properly describing name is given to the variable. For example, `_APP_REDIS_HOST` is an environment variable for Redis connection host. You can find more information on available categories and existing environment variables in the [environment variables doc](https://appwrite.io/docs/environment-variables). ### Describe new environment variable From 115e5657171e6ec422388389c0ea52fbef8db9c5 Mon Sep 17 00:00:00 2001 From: Sayanta Banerjee <53281158+Sayanta66@users.noreply.github.com> Date: Mon, 17 Jan 2022 19:55:05 +0530 Subject: [PATCH 6/6] Update docs/tutorials/add-environment-variable.md Co-authored-by: Aditya Oberai <31401437+adityaoberai@users.noreply.github.com> --- docs/tutorials/add-environment-variable.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials/add-environment-variable.md b/docs/tutorials/add-environment-variable.md index a9c4597071..e056d338d1 100644 --- a/docs/tutorials/add-environment-variable.md +++ b/docs/tutorials/add-environment-variable.md @@ -13,7 +13,7 @@ This tutorial will cover how to properly add a new environment variable in Appwr The environment variables in Appwrite are prefixed with `_APP_`. If it belongs to a specific category, the category name is appended as `_APP_REDIS` for the Redis category. The available categories are General, Redis, MariaDB, InfluxDB, StatsD, SMTP, Storage and Functions. Finally, a properly describing name is given to the variable. For example, `_APP_REDIS_HOST` is an environment variable for Redis connection host. You can find more information on available categories and existing environment variables in the [environment variables doc](https://appwrite.io/docs/environment-variables). ### Describe new environment variable -First of all, we added the new environment variable to `app/config/variables.php` in the designated category. If none of the categories fit, add it to the General category. Copy the existing variable description to create a new one so that you will not miss any required fields. +First of all, we add the new environment variable to `app/config/variables.php` in the designated category. If none of the categories fit, add it to the General category. Copy the existing variable description to create a new one so that you will not miss any required fields. This information is also used to generate the website documentation at https://appwrite.io/docs/environment-variables, so please use good descriptions that clearly define the purpose and other required info about the environment variable that you are adding.