Skip to content
This repository was archived by the owner on Sep 29, 2023. It is now read-only.

Commit 0634ed6

Browse files
authored
Merge pull request #1 from kodumbeats/feat-first-draft
Update docs to latest
2 parents b06161f + 5bd7c57 commit 0634ed6

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

app/views/docs/environment-variables.phtml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ $markdown->setSafeMode(true);
77

88
<p>Appwrite environment variables allow you to edit your server setup configuration and customize it. You can easily change the environment variables by changing them when running Appwrite using Docker CLI or Docker Compose.</p>
99

10-
<p>Updating your Appwrite environment variables requires you to edit your Appwrite docker-compose.yml or .env file. Your Docker files should be located inside the "appwrite" folder at the location where you first run the Appwrite installation script.</p>
10+
<p>Updating your Appwrite environment variables requires you to edit your Appwrite .env file. Your Docker files should be located inside the "appwrite" folder at the location where you first run the Appwrite installation script. It's recommended to use the .env file as a central point for updating your Appwrite configuration rather than changing them directly in your docker-compose.yml file.</p>
1111

1212
<p>After editing your docker-compose.yml or .env files, you will need to restart your Appwrite stack by running the following compose command in your terminal:</p>
1313

app/views/docs/getting-started-for-web.phtml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ $jsVersion = (isset($versions['web'])) ? $versions['web'] : '';
4141

4242
<p>If you're using a bundler (like <a href="http://browserify.org/" target="_blank" rel="noopener">Browserify<a/> or <a href="https://webpack.js.org/" target="_blank" rel="noopener">webpack</a>), you can import the Appwrite module when you need it:</p>
4343

44-
<div class="ide" data-lang="javascript" data-lang-label="Javascript SDK">
44+
<div class="ide" data-lang="javascript" data-lang-label="Web SDK">
4545
<pre class="line-numbers"><code class="prism language-javascript" data-prism>import * as Appwrite from "appwrite";</code></pre>
4646
</div>
4747

@@ -57,7 +57,7 @@ $jsVersion = (isset($versions['web'])) ? $versions['web'] : '';
5757

5858
<p>Initialize your SDK code with your project ID which can be found in your project settings page.</p>
5959

60-
<div class="ide" data-lang="javascript" data-lang-label="Javascript SDK">
60+
<div class="ide" data-lang="javascript" data-lang-label="Web SDK">
6161
<pre class="line-numbers"><code class="prism language-javascript" data-prism>// Init your Web SDK
6262
var appwrite = new Appwrite();
6363

@@ -79,7 +79,7 @@ appwrite
7979

8080
<p>Once your SDK object is set, access any of the Appwrite services and choose any request to send. Full documentation for any service method you would like to use can be found in your SDK documentation or in the API References section.</p>
8181

82-
<div class="ide" data-lang="javascript" data-lang-label="Javascript SDK">
82+
<div class="ide" data-lang="javascript" data-lang-label="Web SDK">
8383
<pre class="line-numbers"><code class="prism language-javascript" data-prism>// Register User
8484
appwrite
8585
.account.create('[email protected]', 'password', 'Jane Doe')
@@ -92,7 +92,7 @@ appwrite
9292
</div>
9393

9494
<h2>Full Example</h2>
95-
<div class="ide" data-lang="javascript" data-lang-label="Javascript SDK">
95+
<div class="ide" data-lang="javascript" data-lang-label="Web SDK">
9696
<pre class="line-numbers"><code class="prism language-javascript" data-prism>// Init your Web SDK
9797
var appwrite = new Appwrite();
9898

app/views/docs/installation.phtml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050

5151
<h3>Manual</h3>
5252

53-
<p>For advanced Docker users, the manual installation might seem more familiar. To setup Appwrite manually, download the Appwrite base <a href="/docker-compose.yml" target="_blank">docker-compose.yml</a> file. After the download completes, update the different environment variables as you wish and start the Appwrite stack using the following Docker command:</p>
53+
<p>For advanced Docker users, the manual installation might seem more familiar. To setup Appwrite manually, download the Appwrite base <a href="https://gist.github.com/eldadfux/977869ff6bdd7312adfd4e629ee15cc5" target="_blank">docker-compose.yml and .env</a> files. After the download completes, update the different environment variables as you wish in the .env file and start the Appwrite stack using the following Docker command:</p>
5454

5555
<div class="ide margin-bottom" data-lang="bash" data-lang-label="Bash">
5656
<pre class="line-numbers"><code class="prism language-bash" data-prism>docker-compose up -d --remove-orphans</code></pre>
@@ -66,4 +66,4 @@
6666
<li class="margin-bottom-tiny"><a href="/docs/production" rel="noopener"><i class="icon-angle-circled-right margin-start-negative-tiny margin-end-tiny"></i> Running Appwrite in production</a></li>
6767
<li class="margin-bottom-tiny"><a href="/docs/environment-variables" rel="noopener"><i class="icon-angle-circled-right margin-start-negative-tiny margin-end-tiny"></i> Appwrite server environment variables</a></li>
6868
<li class="margin-bottom-tiny"><a href="/docs/email-delivery" rel="noopener"><i class="icon-angle-circled-right margin-start-negative-tiny margin-end-tiny"></i> Appwrite setting a custom SMTP server</a></li>
69-
</ul>
69+
</ul>

app/views/docs/permissions.phtml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@
9494

9595
<p>In the following example, we are creating a document that can be read by everyone and only be edited, or deleted by a user with a UID <span class="tag">user:5c1f88b42259e</span>.</p>
9696

97-
<div class="ide" data-lang="javascript" data-lang-label="Javascript SDK">
97+
<div class="ide" data-lang="javascript" data-lang-label="Web SDK">
9898
<pre class="line-numbers"><code class="prism language-javascript" data-prism>let sdk = new Appwrite();
9999

100100
sdk
@@ -121,7 +121,7 @@ promise.then(function (response) {
121121

122122
<p>In the following example, we are creating a document that can be read-only by members of <span class="tag">team:5c1f88b87435e</span> and can only be edited, or deleted by members of the same team that possesses the role <span class="tag">owner</span>.</p>
123123

124-
<div class="ide" data-lang="javascript" data-lang-label="Javascript SDK">
124+
<div class="ide" data-lang="javascript" data-lang-label="Web SDK">
125125
<pre class="line-numbers"><code class="prism language-javascript" data-prism>let sdk = new Appwrite();
126126

127127
sdk

0 commit comments

Comments
 (0)