Merge pull request #76 from secureCodeBox/feature/improve-readme-files

Added the persistence Hook for static reporting

Author: J12934

docs/developer-guide/README.md

@@ -1,3 +1,11 @@
+---
+title: "Developer Guide"
+path: "docs/developer-guide"
+category: "develop"
+---
+
+<!-- end -->
+
 # Extending secureCodeBox
 
 ## Developing the SCB Operator
@@ -86,21 +94,32 @@ cd operator
 make run
 ```
 
-## How to a New Security Scanner
+## How to add a New Security Scanner
 
 ### ScanType Definition
+> ✍ **Following...**
 
 ### Parsing SDK
 
+1. Install the dependencies `npm install`
+2. Update the parser function here: `./parser/parser.js`
+3. Update the parser tests here: `./parser/parser.test.js`
+4. Run the test suite: `npm test`
+
 ## How to Integrate a New Hook
+> ✍ **Following...**
 
 ### HookType Definition
+> ✍ **Following...**
 
 ### Hook SDK
+> ✍ **Following...**
 
 ## Guidelines
+> ✍ **Following...**
 
 ### Coding Guidelines
+> ✍ **Following...**
 
 #### JSON
 

docs/user-guide/README.md

@@ -1,3 +1,11 @@
+---
+title: "User Guide"
+path: "docs/user-guide"
+category: "use"
+---
+
+<!-- end -->
+
 # Using the secureCodeBox
 
-follwing...
+> ✍ **Page under construction.**

hooks/declarative-subsequent-scans/README.md

@@ -63,7 +63,7 @@ spec:
 EOF
 ```
 
-This Scan will used all CascadingRules which are labeled with a "light" intensity.
+This Scan will use all CascadingRules which are labeled with a "light" intensity.
 You can lookup which CascadingRules this selects by running:
 
 ```bash

hooks/generic-webhook/README.md

@@ -16,3 +16,4 @@ Installing the Generic WebHook hook will add a ReadOnly Hook to your namespace.
 ```bash
 helm upgrade --install gwh ./hooks/generic-webhook/ --set webhookUrl="http://example.com/my/webhook/target"
 ```
+> ✍ This documentation is currently work-in-progress. 

hooks/imperative-subsequent-scans/README.md

@@ -0,0 +1,10 @@
+---
+title: "Imperative  Scans"
+path: "hooks/imperative-subsequent-scans"
+category: "hook"
+type: "integration"
+state: "roadmap"
+usecase: "Cascading Scans based imperative Rules."
+---
+
+> 🔧 The implementation is currently work-in-progress and still undergoing major changes. It'll be released here once it has stabilized.

hooks/persistence-defectdojo/README.md

@@ -3,7 +3,7 @@ title: "DefectDojo"
 path: "hooks/persistence-defectdojo"
 category: "hook"
 type: "persistenceProvider"
-state: "roadmap"
+state: "developing"
 usecase: "Publishes all Scan Findings to DefectDojo."
 ---
 
@@ -18,7 +18,7 @@ Tools which are supported both by the secureCodeBox and DefectDojo (OWASP ZAP &
 To learn more about DefectDojo visit [DefectDojo GitHub] or [DefectDojo Website].
 
 ## Deployment
-The secureCodeBox core team is working on an integration of DefectDojo. We will keep you informed.
+> 🔧 The implementation is currently work-in-progress and under still undergoing major changes. It'll be released here once it has stabilized.
 
 
 [DefectDojo Website]: https://www.defectdojo.org/

hooks/persistence-elastic/README.md

@@ -10,7 +10,7 @@ usecase: "Publishes all Scan Findings to Elasticsearch."
 <!-- end -->
 
 ## About
-The ElasticSearch persistenceProvider hook saves all findings and reports into the configured ElasticSearch index. This allows for some easy searching and visualization of the findings. To learn more about Elasticsearch visit elastic.io.
+The ElasticSearch persistenceProvider hook saves all findings and reports into the configured ElasticSearch index. This allows for some easy searching and visualization of the findings. To learn more about Elasticsearch visit [elastic.io].
 
 ## Deployment
 
@@ -52,4 +52,6 @@ elasticsearch:
 kibana:
   enabled: true
   # image: docker.elastic.co/kibana/kibana-oss
-```
+```
+
+[elastic.io]: https://www.elastic.co/products/elasticsearch

hooks/persistence-static-report/README.md

@@ -0,0 +1,15 @@
+---
+title: "Static Report"
+path: "hooks/persistence-staticreport"
+category: "hook"
+type: "persistenceProvider"
+state: "developing"
+usecase: "Publishes all Scan Findings as HTML Report."
+---
+
+<!-- end -->
+
+## Deployment
+
+> 🔧 The implementation is currently work-in-progress and still undergoing major changes. It'll be released here once it has stabilized.
+

hooks/slack-webhook/README.md

@@ -13,4 +13,4 @@ usecase: "Publishes Scan Summary to Slack."
 
 Installing the Slack WebHook hook will add a ReadOnly Hook to your namespace. 
 
-The secureCodeBox core team is working on this, we will keep you informed.
+> 🔧 The implementation is currently work-in-progress and still undergoing major changes. It'll be released here once it has stabilized.

hooks/teams-webhook/README.md

@@ -13,4 +13,4 @@ usecase: "Publishes Scan Summary to MS Teams."
 
 Installing the Teams WebHook hook will add a ReadOnly Hook to your namespace. 
 
-The secureCodeBox core team is working on this, we will keep you informed.
+> 🔧 The implementation is currently work-in-progress and still undergoing major changes. It'll be released here once it has stabilized.