keptn#537 Provide Readme for each project

odubajDT · Jul 30, 2019 · b29728a · b29728a
1 parent beb1013
commit b29728a
Show file tree

Hide file tree

Showing 10 changed files with 17 additions and 205 deletions.
diff --git a/api/README.md b/api/README.md
@@ -0,0 +1 @@
+# API component
diff --git a/cli/README.md b/cli/README.md
@@ -0,0 +1 @@
+# keptn cli
diff --git a/distributor/LICENSE b/distributor/LICENSE
diff --git a/distributor/README.md b/distributor/README.md
@@ -0,0 +1 @@
+# Distributor
diff --git a/eventbroker/README.md b/eventbroker/README.md
@@ -0,0 +1 @@
+# Eventbroker
diff --git a/gatekeeper-service/README.md b/gatekeeper-service/README.md
@@ -1,3 +1,3 @@
-# gatekeeper-service
+# Gatekeeper Service
 
 Service which implements the quality gate, i.e., depending on the evaluation result it either promotes an artifact to the next stage or not. Therefore, this service listens on `evaluation-done` events, which contains the result of the evaluation. In case the evaluation result is positive, this service sends a `new-artifact` event. In case the evaluation result is negative and the service is deployed with a b/g strategy, this service changes the configuration back to the old version and sends a `configuration-changed` event.
diff --git a/helm-service/README.md b/helm-service/README.md
@@ -1,2 +1,3 @@
-# keptn helm service
+# keptn Helm Service
+
 Services that fetches configuration files from GitHub and applies those using helm.
diff --git a/jmeter-service/README.md b/jmeter-service/README.md
@@ -1,2 +1,2 @@
-# jmeter-service
+# keptn Jmeter Service
 Service for triggering JMeter tests. Therefore, this service listens on `deployment-finished` events and then starts the tests. In case the tests succeeed, this service sends a `test-finished` event. In case the tests do not succeed (e.g. the error rate is too high), this service sends an `evaluation-done` event with the data `evaluationpassed=false`.
diff --git a/releasenotes/releasenotes_V0.4.0.md b/releasenotes/releasenotes_V0.4.0.md
@@ -1,4 +1,4 @@
-# Release Notes 0.4.04
+# Release Notes 0.4.0
 
 ## New Features
 - Deploy the installer as a Job instead of Deployment [#456](https://github.com/keptn/keptn/issues/456)

diff --git a/releasenotes/releasenotes_develop.md b/releasenotes/releasenotes_develop.md
@@ -0,0 +1,8 @@
+# Release Notes x.x.x
+
+## New Features
+- 
+
+## Fixed Issues
+
+## Known Limitations