preparing docs for stages

.eslintrc.json

@@ -4,5 +4,6 @@
 	},
 	"root": true,
 	"plugins": ["@swrlab/eslint-plugin-swr"],
-	"extends": ["plugin:@swrlab/eslint-plugin-swr/recommended"]
+	"extends": ["plugin:@swrlab/eslint-plugin-swr/recommended"],
+	"ignorePatterns": ["docs/_SIDEBAR.md"]
 }

CHANGELOG.md

@@ -1,5 +1,3 @@
-# ARD-Eventhub (Working Title)
-
-## Changelog
+# ARD-Eventhub / Changelog
 
 Coming soon...

README.md

@@ -3,12 +3,12 @@
 ARD system to distribute real-time (live) metadata for primarily radio broadcasts. During development, please head over to [./issues](https://github.com/swrlab/ard-eventhub/issues) and [./discussions](https://github.com/swrlab/ard-eventhub/discussions) for current topics and updates.
 
 - [ARD-Eventhub](#ard-eventhub)
-     - [Get involved](#get-involved)
-     - [Modules](#modules)
-          - [Ingest](#ingest)
-     - [Documentation](#documentation)
-     - [License](#license)
-     - [Third-Party Components](#third-party-components)
+  - [Get involved](#get-involved)
+  - [Modules](#modules)
+    - [Ingest](#ingest)
+  - [Documentation](#documentation)
+  - [License](#license)
+  - [Third-Party Components](#third-party-components)
 
 ## Get involved
 
@@ -31,6 +31,7 @@ There are several documents available, that explain different parts of this serv
 - [docs/AUTHENTICATION.md](./docs/AUTHENTICATION.md) - This guides you through the steps needed to login and work with this API
 - [docs/EVENTS.md](docs/EVENTS.md) - These are the events, that you can currently distribute through Eventhub
 - [docs/SECRETS.md](docs/SECRETS.md) - List of secrets that are used and stored in different places
+- [docs/STAGES.md](docs/STAGES.md) - Stage configuration for all modules
 - [docs/TYPES.md](docs/TYPES.md) - The different content types inside events, that can be used
 - [docs/USERS.md](docs/USERS.md) - How to work with user accounts
 

docs/AUTHENTICATION.md

@@ -19,7 +19,7 @@ This page explicitly covers the login methods for the ARD-Eventhub API. Compared
 
 **POST `{HOST}/auth/login`**
 
-```js
+```json
 {
   "email": "[email protected]",
   "password": "my-password"
@@ -28,14 +28,14 @@ This page explicitly covers the login methods for the ARD-Eventhub API. Compared
 
 Returns `200 OK`
 
-```js
+```json
 {
   "expiresIn": 3600,
   "expires": "2021-03-12T12:55:22.995Z",
   "token": "eyABCDEF.GHIJKL....",
   "refreshToken": "AOabcdefghijkl",
   "user": {
-    /* ... */
+    "some": "objects"
   },
   "trace": null
 }
@@ -49,22 +49,22 @@ While the normal `token` expires, the `refreshToken` can be used for a longer pe
 
 **POST `{HOST}/auth/refresh`**
 
-```js
+```json
 {
   "refreshToken": "abcXYZ..."
 }
 ```
 
 Returns `200 OK`
 
-```js
+```json
 {
   "expiresIn": 3600,
   "expires": "2021-03-12T12:55:22.995Z",
   "token": "eyABCDEF.GHIJKL....",
   "refreshToken": "AOabcdefghijkl",
   "user": {
-    /* ... */
+    "some": "objects"
   },
   "trace": null
 }
@@ -86,7 +86,7 @@ Sometimes you might loose your old password and need to reset it. If this happen
 
 **POST `{HOST}/auth/reset`**
 
-```js
+```json
 {
   "email": "[email protected]"
 }

docs/STAGES.md

@@ -0,0 +1,27 @@
+# ARD-Eventhub / Stages
+
+The Eventhub differentiates by stages given to the service via env `STAGE` and different runtime environments, such as a deployment to beta, test, or similar.
+
+- [ARD-Eventhub / Stages](#ard-eventhub--stages)
+  - [Ingest](#ingest)
+    - [Ingest Service Stages](#ingest-service-stages)
+    - [Ingest Deployment Stages](#ingest-deployment-stages)
+
+## Ingest
+
+### Ingest Service Stages
+
+| Module      | `dev`           | `prod`           |
+| ----------- | --------------- | ---------------- |
+| Database    | Namespace `dev` | Namespace `prod` |
+| Dev Logging | true            | false            |
+
+### Ingest Deployment Stages
+
+| Module             | `dev`                       | `test`                              | `beta`           | `prod`           |
+| ------------------ | --------------------------- | ----------------------------------- | ---------------- | ---------------- |
+| Used Ingest Stage  | `dev`                       | `dev`                               | `prod`           | `prod`           |
+| Stable             | No, used for internal tests | Yes, can be used for external tests | Ususally         | Yes              |
+| Runtime            | Cloud Run                   | Kubernetes                          | Kubernetes       | Kubernetes       |
+| Container Registry | Eventhub project            | Eventhub project                    | Eventhub project | Eventhub project |
+| URL                | n/a                         | n/a                                 | n/a              | n/a              |

docs/_SIDEBAR.md

@@ -1,6 +1,10 @@
 - [ARD-Eventhub Overview](/ 'ARD-Eventhub')
 - [Authentication](/docs/AUTHENTICATION.md)
+- [Changelog](/CHANGELOG.md)
 - [Events](/docs/EVENTS.md)
 - [Secrets](/docs/SECRETS.md)
+- [Stages](/docs/STAGES.md)
 - [Types](/docs/TYPES.md)
 - [Users](/docs/USERS.md)
+
+> Created by SWR Audio Lab and ARD Online

index.html

@@ -20,5 +20,6 @@
 		</script>
 		<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
 		<script src="//cdn.jsdelivr.net/npm/docsify-copy-code"></script>
+		<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-json.min.js"></script>
 	</body>
 </html>