Merge pull request #1601 from starknet-io/migration/readme

Migration/readme
starknet-io · Nov 7, 2023 · d8303ea · d8303ea
2 parents a331eb5 + 76a1db2
commit d8303ea
Show file tree

Hide file tree

Showing 3 changed files with 67 additions and 0 deletions.
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
@@ -46,3 +46,38 @@ npm run deploy
 Note how we define a fetch function at `pageContext.fetch` that is universal: it works for development as well as for the production worker.
 
 The trick is to provide a different `fetch()` implementation at [worker/ssr.ts](worker/ssr.ts) and [dev-server/index.js](dev-server/index.js).
+
+
+## Deployment
+the starknet website is deployed to cloudflare pages with the configuration below:
+
+| Configuration | Value             |
+|---------------|-------------------|
+| Name          | starknet-websites |
+| usage model   | Unbound           |
+
+### environment variables and secrets
+#### in github
+| Name                        | Type   | Description                                                   |
+|-----------------------------|--------|---------------------------------------------------------------|
+| ALGOLIA_APP_ID              | Secret | algolia app token                                             |
+| VITE_ALGOLIA_SEARCH_API_KEY | Secret | algolia api search key token                                  |
+| CF_STREAM_URL               | Secret | the cloudflare video stream url                               |
+| VITE_ED_VIDEO_ID_1          | Secret | the cloudflare video 1 ID  (found in cloudflare video stream) |
+| VITE_ED_VIDEO_ID_2          | Secret | the cloudflare video 2 ID  (found in cloudflare video stream) |
+| VITE_ED_VIDEO_ID_3          | Secret | the cloudflare video 3 ID  (found in cloudflare video stream) |
+| VITE_ED_VIDEO_ID_4          | Secret | the cloudflare video 4 ID  (found in cloudflare video stream) |
+#### in Cloudflare pages
+| Name | Type   | Description     |
+|------|--------|-----------------|
+| YOUTUBE_API_KEY | Secret | youtube api key |
+
+### Multimedia
+#### Videos
+Videos are hosted in cloudflare stream service, under videos we have all the video used in starknet.io
+#### Images
+Images are using cloudflare optimisation service (found under: cloudflare starknet.io domain > speed > optimization > image optimization) with the configuration below enabled
+- Polish
+- Protocol HTTP/2
+- Protocol HTTP/2 to Origin
+- Protocol TLS 1.3