update readme files

starknet-io · Nov 7, 2023 · 76a1db2 · 76a1db2
1 parent 33d636c
commit 76a1db2
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 1 deletion.
diff --git a/workspaces/netlify-cms-auth/Readme.md b/workspaces/netlify-cms-auth/Readme.md
@@ -0,0 +1,15 @@
+## Deployment
+the CMS auth has a [url callback whitelist](src/callback.ts?plain=63) and is deployed to cloudflare worker with the configuration below:
+
+| Configuration | Value             |
+|---------------|-------------------|
+| Name          | netlify-cms-auth  |
+| usage model   | Unbound           |
+
+### enviroment variables and secrets
+#### in cloudflare
+| Name                       | Type    | Description                                     |
+|----------------------------|---------|-------------------------------------------------|
+| OAUTH_GITHUB_CLIENT_ID     | Secret  | github Oauth client ID (under starknet org)     |
+| OAUTH_GITHUB_CLIENT_SECRET | Secret  | github Oauth client Secret (under starknet org) |
+
diff --git a/workspaces/netlify-cms/Readme.md b/workspaces/netlify-cms/Readme.md
@@ -0,0 +1,17 @@
+## Deployment
+the CMS is deployed to cloudflare pages with the configuration below:
+
+| Configuration | Value                |
+|---------------|----------------------|
+| Name          | starknet-netlify-cms |
+| usage model   | Bundled              |
+
+### environment variables and secrets
+#### in github
+| Name                   | Type       | Description                                                |
+|------------------------|------------|------------------------------------------------------------|
+| VITE_LIVE_PREVIEW_URL  | Variable   | declared in the pipeline (netlify-cms.yml)                 |
+| VITE_GIT_BRANCH_NAME   | Variable   | declared in the pipeline (netlify-cms.yml)                 |
+| VITE_API_BASE_URL      | Variable   | declared in the pipeline (netlify-cms.yml)                 |
+| VITE_DATA_URL          | Variable   | declared in the pipeline (netlify-cms.yml)                 |
+| VITE_BACKEND_AUTH_URL  | Variable   | CMS auth url -- declared in the pipeline (netlify-cms.yml) |
diff --git a/workspaces/website/readme.md b/workspaces/website/readme.md
@@ -56,7 +56,7 @@ the starknet website is deployed to cloudflare pages with the configuration belo
 | Name          | starknet-websites |
 | usage model   | Unbound           |
 
-### enviroment variables and secrets
+### environment variables and secrets
 #### in github
 | Name                        | Type   | Description                                                   |
 |-----------------------------|--------|---------------------------------------------------------------|