From 6a333e79d2b9531bc272840527bdd2192d344481 Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Fri, 15 Jul 2022 17:09:34 -0400 Subject: [PATCH 1/2] Update instructions to generate new specifications The old instructions for generating new specifications + new SDK no longer work. This aims to update the instructions. --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0a0cf85c11..cfaa18047a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -317,8 +317,8 @@ The Runtimes for all supported cloud functions (multicore builds) can be found a For generating a new console SDK follow the next steps: -1. Update the console spec file located at `app/config/specs/swagger2-0.12.x.console.json` from the dynamic version located at `https://localhost/specs/swagger2?platform=console` -2. Generate a new SDK using the command `php app/cli.php sdks` +1. Update the console spec file located at `app/config/specs/swagger2-.console.json` using the Appwrite CLI tools. Run the `php app/cli.php specs normal` command in a running `appwrite/appwrite` container.. +2. Generate a new SDK using the command `php app/cli.php sdks ` 3. Change your working dir using `cd app/sdks/console-web` 4. Build the new SDK `npm run build` 5. Copy `iife/sdk.js` to `appwrite.js` @@ -462,4 +462,4 @@ Submitting documentation updates, enhancements, designs, or bug fixes. Spelling ### Helping Someone -Searching for Appwrite on Discord, GitHub, or StackOverflow and helping someone else who needs help. You can also help by teaching others how to contribute to Appwrite's repo! \ No newline at end of file +Searching for Appwrite on Discord, GitHub, or StackOverflow and helping someone else who needs help. You can also help by teaching others how to contribute to Appwrite's repo! From 310409355aaffc1012a44d0faef583789f752358 Mon Sep 17 00:00:00 2001 From: Wen Yu Ge Date: Mon, 18 Jul 2022 13:39:00 -0400 Subject: [PATCH 2/2] update generation steps according to suggestion --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cfaa18047a..0a83f043ff 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -317,8 +317,8 @@ The Runtimes for all supported cloud functions (multicore builds) can be found a For generating a new console SDK follow the next steps: -1. Update the console spec file located at `app/config/specs/swagger2-.console.json` using the Appwrite CLI tools. Run the `php app/cli.php specs normal` command in a running `appwrite/appwrite` container.. -2. Generate a new SDK using the command `php app/cli.php sdks ` +1. Update the console spec file located at `app/config/specs/swagger2-.console.json` using Appwrite Tasks. Run the `php app/cli.php specs normal` command in a running `appwrite/appwrite` container. +2. Generate a new SDK using the command `php app/cli.php sdks` 3. Change your working dir using `cd app/sdks/console-web` 4. Build the new SDK `npm run build` 5. Copy `iife/sdk.js` to `appwrite.js`