From 325880b663228a09eed24ef14fec7aa6d55a88ed Mon Sep 17 00:00:00 2001 From: Ebenezer Don Date: Thu, 12 Dec 2024 18:29:57 +0000 Subject: [PATCH 1/4] docs: clarify SQL database in collections doc --- src/routes/docs/products/databases/collections/+page.markdoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/routes/docs/products/databases/collections/+page.markdoc b/src/routes/docs/products/databases/collections/+page.markdoc index e6c6ba9593..cce38cce9f 100644 --- a/src/routes/docs/products/databases/collections/+page.markdoc +++ b/src/routes/docs/products/databases/collections/+page.markdoc @@ -4,7 +4,8 @@ title: Collections 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. +While Appwrite uses SQL, the terms collections and documents are used because the Appwrite JSON REST API resembles +the API of a traditional NoSQL database, making it intuitive and user-friendly. That said, Appwrite is designed to support both SQL and NoSQL database adapters like MariaDB, MySQL, or MongoDB in future versions. From e2becc9e36e14e94ae4da22dfff607e9608e7b7f Mon Sep 17 00:00:00 2001 From: Ebenezer Don Date: Thu, 12 Dec 2024 18:30:29 +0000 Subject: [PATCH 2/4] Add cli-disclaimer partial path to markdoc config - fixes syntax error --- markdoc.config.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/markdoc.config.json b/markdoc.config.json index 28dbbe652e..ad6a9ebb07 100644 --- a/markdoc.config.json +++ b/markdoc.config.json @@ -9,7 +9,8 @@ "watch": true }, "partials": { - "auth-security.md": "./src/partials/auth-security.md" + "auth-security.md": "./src/partials/auth-security.md", + "cli-disclaimer.md": "./src/partials/cli-disclaimer.md" } } ] From c3d094fb8eb25487a4cc0d2e752bdcf793dc82a0 Mon Sep 17 00:00:00 2001 From: Ebenezer Don Date: Fri, 13 Dec 2024 11:26:14 +0000 Subject: [PATCH 3/4] Adjust wording to flow with previous sentence --- markdoc.config.json | 3 +-- .../docs/products/databases/collections/+page.markdoc | 9 ++++----- 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/markdoc.config.json b/markdoc.config.json index ad6a9ebb07..28dbbe652e 100644 --- a/markdoc.config.json +++ b/markdoc.config.json @@ -9,8 +9,7 @@ "watch": true }, "partials": { - "auth-security.md": "./src/partials/auth-security.md", - "cli-disclaimer.md": "./src/partials/cli-disclaimer.md" + "auth-security.md": "./src/partials/auth-security.md" } } ] diff --git a/src/routes/docs/products/databases/collections/+page.markdoc b/src/routes/docs/products/databases/collections/+page.markdoc index cce38cce9f..d6473a7380 100644 --- a/src/routes/docs/products/databases/collections/+page.markdoc +++ b/src/routes/docs/products/databases/collections/+page.markdoc @@ -4,8 +4,7 @@ title: Collections 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. -While Appwrite uses SQL, the terms collections and documents are used because the Appwrite JSON REST API resembles -the API of a traditional NoSQL database, making it intuitive and user-friendly. +The terms collections and documents are used because the Appwrite JSON REST API resembles the API of a traditional NoSQL database, making it intuitive and user-friendly, even though Appwrite uses SQL under the hood. That said, Appwrite is designed to support both SQL and NoSQL database adapters like MariaDB, MySQL, or MongoDB in future versions. @@ -108,9 +107,9 @@ require 'Appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('') # Your project ID - .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + .set_endpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .set_project('') // Your project ID + .set_key('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key databases = Databases.new(client) From 1189afffe3ae4cd913cf6a93c79763cb60129a0d Mon Sep 17 00:00:00 2001 From: Ebenezer Don Date: Thu, 2 Jan 2025 12:10:25 +0000 Subject: [PATCH 4/4] Fix ruby code comments --- .../docs/products/databases/collections/+page.markdoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/routes/docs/products/databases/collections/+page.markdoc b/src/routes/docs/products/databases/collections/+page.markdoc index d6473a7380..f158c87f97 100644 --- a/src/routes/docs/products/databases/collections/+page.markdoc +++ b/src/routes/docs/products/databases/collections/+page.markdoc @@ -107,9 +107,9 @@ require 'Appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .set_project('') // Your project ID - .set_key('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases.new(client)