From 1c7ea54a1ff97d60ada2869f0c636f2a62277797 Mon Sep 17 00:00:00 2001
From: Daniel Freytag <daniel@frytg.com>
Date: Thu, 26 Jan 2023 12:34:14 +0100
Subject: [PATCH] chore: update ingest docs

---
 .editorconfig            | 42 ++++++++++++++++++++++++++++++++++++++++
 .gitignore               |  2 +-
 keys/.gitkeep            |  0
 keys/secret.example.yaml | 11 -----------
 src/ingest/README.md     | 35 ++++++++++++++-------------------
 5 files changed, 58 insertions(+), 32 deletions(-)
 create mode 100644 .editorconfig
 delete mode 100644 keys/.gitkeep
 delete mode 100644 keys/secret.example.yaml

diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 00000000..81f76721
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,42 @@
+# docs: https://editorconfig.org
+# please make sure to keep this file in sync between repositories
+# to main file should be edited in `swr-prettier-config` and copied where needed
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = tab
+indent_size = 8
+print_width = 111
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+indent_style = space
+indent_size = 2
+
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2
+
+# LiquidSoap config files
+[*.liq]
+indent_style = space
+indent_size = 2
+
+# Terraform config files
+[*.tf]
+indent_style = space
+indent_size = 2
+
+# Linting toml config files
+[*.toml]
+indent_style = space
+indent_size = 2
+
+# Auto-generated CSV Files
+[*.csv]
+insert_final_newline = false
diff --git a/.gitignore b/.gitignore
index 098e6ea5..f7a26e8a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -7,7 +7,7 @@ yarn-error.log*
 .DS_STORE
 
 # keys
-keys/*.json
+keys/
 .env
 
 # Dependency directories
diff --git a/keys/.gitkeep b/keys/.gitkeep
deleted file mode 100644
index e69de29b..00000000
diff --git a/keys/secret.example.yaml b/keys/secret.example.yaml
deleted file mode 100644
index 1b13d37a..00000000
--- a/keys/secret.example.yaml
+++ /dev/null
@@ -1,11 +0,0 @@
-apiVersion: v1
-kind: Secret
-type: Opaque
-
-metadata:
-  name: eventhub-ingest-secrets
-
-data:
-  DTS_KEYS: BASE_64_OF_DTS_KEYS
-  FIREBASE_API_KEY: BASE_64_OF_FIREBASE_KEY
-  GCP_SA_KEY: BASE_64_OF_GCP_JSON_KEY
diff --git a/src/ingest/README.md b/src/ingest/README.md
index b520aa7a..6e70e8eb 100644
--- a/src/ingest/README.md
+++ b/src/ingest/README.md
@@ -1,10 +1,16 @@
-# ARD-Eventhub
-
-## Ingest
+# ARD-Eventhub Ingest
 
 The Ingest service is used to accept incoming events, distribute them via Pub/Sub and provide methods for users to manage their own subscriptions (self-service).  
 
-### Environments
+- [ARD-Eventhub Ingest](#ard-eventhub-ingest)
+  - [Environments](#environments)
+  - [Stages](#stages)
+    - [DEV](#dev)
+    - [PROD](#prod)
+  - [Setup](#setup)
+  - [Deployment](#deployment)
+
+## Environments
 
 Designated host is Kubernetes but the Docker container will also be used in other environments such as Google Cloud Run for testing purposes.
 
@@ -18,15 +24,15 @@ Several environment variables need to be set in `.env` config in order to run th
 - OPTIONAL `PORT` - override server port setting, default is 8080
 - OPTIONAL `DEBUG` - set true to enable more detailed logging
 
-### Stages
+## Stages
 
 Some staging information is auto-detected (whether to run tracing or not), some is configured by the `STAGE` variable.
 
-#### DEV
+### DEV
 
 Main difference is the prefix used for Pub/Sub topics, which includes `DEV-`.
 
-#### PROD
+### PROD
 
 Uses full production prefixes and configuration.
 
@@ -51,21 +57,10 @@ To run this project locally in your development environment you'll need these pr
    yarn ingest:local
    ```
 
-6. Open http://localhost:8080/openapi/
+6. Open [localhost:8080/openapi](http://localhost:8080/openapi/)
 
 ## Deployment
 
 The deployment process of Eventhub-Ingest is different for `Non-Prod` and `Prod`-Stages
 
-### Dev, Test, Stage
-
-Deployments for Stages `Dev`, `Test` and `Stage` can be done in Github-Actions after the run completed successful.
-
-### Prod
-
-Deployments for `Prod` need to be done by external ARD-Service. Therefore request the rollout by sending following E-Mail:
-
-- To: `Christian.Hufnagel@swr.de`
-- Cc: `Julius.Zimmermann@ard.de`
-- Subject: Prod-Deployment of Eventhub-Ingest
-- Text: I request to deploy the following version of the eventhub-ingest on prod: `<docker-version-tag>`
+Deployments for all stages will be done in Github-Actions after the run completed successful.