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

Commit ddf14fb

Browse files
author
Vincent (Wen Yu) Ge
committed
Consistent use of Best Practice, Scope, and reordered index to match dashboard
1 parent 8f27ccf commit ddf14fb

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

app/views/docs/index.phtml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,11 @@ $cols = [
7171
</div>
7272

7373
<ul class="margin-bottom">
74-
<li><a href="/docs/authentication">Authentication</a></li>
75-
<li><a href="/docs/realtime">Realtime</a></li>
7674
<li><a href="/docs/databases">Databases</a></li>
7775
<li><a href="/docs/storage">Storage</a></li>
76+
<li><a href="/docs/authentication">Authentication</a></li>
7877
<li><a href="/docs/functions">Functions</a></li>
78+
<li><a href="/docs/realtime">Realtime</a></li>
7979
</ul>
8080

8181
<div class="margin-bottom-small">

app/views/docs/keys.phtml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ $scopes = $this->getParam('scopes', );
44

55
<p>Using your API Keys, you can access Appwrite services using the SDK of your choice. To create a new API key, go to your API keys tab in your project setting using your Appwrite console and click the 'Add API Key' button.</p>
66

7-
<p>When adding a new API Key, you can choose which permission scope to grant your application. If you need to replace your API Key, create a new key, update your app credentials and, once ready, delete your old key.</p>
7+
<p>When adding a new API Key, you can choose which scope to grant your application. If you need to replace your API Key, create a new key, update your app credentials and, once ready, delete your old key.</p>
88

99
<div class="notice">
10-
<h2>Best Practices</h2>
11-
<p>It is a best practice to allow only the permissions you need to meet your project goals. API keys should be treated as a secret. Never share the API key and keep API keys out of client applications.</p>
10+
<h2>Best Practice</h2>
11+
<p>It is a best practice to grant only the scopes you need to meet your project's goals to an API key. API keys should be treated as a secret. Never share the API key and keep API keys out of client applications.</p>
1212
</div>
1313

1414
<h2 id="scopes">Scopes</h2>

app/views/docs/production.phtml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<p>Make sure to keep this key in a safe place and never make it publicly accessible. There are many online resources with methods of keeping your secret keys safe in your servers.</p>
88

99
<div class="notice">
10-
<h2>Best Practices</h2>
10+
<h2>Best Practice</h2>
1111
<p>You should always prefer <b>https</b> over http in production environments. This keeps your APIs secure and prevents any redirects from interfering with your requests.</p>
1212
</div>
1313

0 commit comments

Comments
 (0)