Skip to content
This repository was archived by the owner on Oct 14, 2020. It is now read-only.

Commit 52c9a71

Browse files
committed
Added some readme files to improve documentation.
1 parent a5adc9a commit 52c9a71

File tree

14 files changed

+40
-6
lines changed

14 files changed

+40
-6
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,9 @@ The typical way to ensure application security is to hire a security specialist
6565

6666
With the _secureCodeBox_ we provide a toolchain for continuous scanning of applications to find the low-hanging fruit issues early in the development process and free the resources of the penetration tester to concentrate on the major security issues.
6767

68-
The purpose of _secureCodeBox_ **is not** to replace the penetration testers or make them obsolete. We strongly recommend running extensive tests by experienced penetration testers on all your applications.
68+
![secureCodeBox Architecture](./docs/resources/macbook_kibana.jpg)
69+
70+
The purpose of _secureCodeBox_ **is not** to replace the penetration testers or make them obsolete. We strongly recommend to run extensive tests by experienced penetration testers on all your applications.
6971

7072
**Important note**: The _secureCodeBox_ is no simple one-button-click-solution! You must have a deep understanding of security and how to configure the scanners. Furthermore, an understanding of the scan results and how to interpret them is also necessary.
7173

docs/developer-guide/Architecture.md

Whitespace-only changes.

docs/developer-guide/CRDs.md

Whitespace-only changes.

docs/developer-guide/Hooks.md

Whitespace-only changes.

docs/developer-guide/Operator.md

Whitespace-only changes.

docs/developer-guide/Scanners.md

Whitespace-only changes.

docs/glossary.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Glossary
2+
3+
This overview provides a description for all acronyms and special terms which are used in this project. If you encounter any missing terms, please [let us know](https://github.com/corona-warn-app/cwa-documentation/issues/new?labels=documentation%2C+bug&template=01_doc_issue.md) or [create a pull request](https://github.com/secureCodeBox/secureCodeBox-v2/pulls).
4+
5+
| Term, acronym... | Description |
6+
| --- | --- |
7+
| API | An [Application Programming Interface](https://en.wikipedia.org/wiki/Application_programming_interface) (API) is a computing interface which defines interactions between multiple software intermediaries. |
8+
| CRD | Acronym for "[Custom Ressource Definition](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)". |
9+
| GUID | Acronym for "[Globally Unique Identifier](https://en.wikipedia.org/wiki/Universally_unique_identifier)". |
10+
| K8S | Acronym for "[Kubernetes](https://kubernetes.io/docs/home/)". |
11+
| SCB | Acronym for "[secureCodeBox (This Project)](https://www.secureCodeBox.io)". |
12+
13+

docs/index.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,16 @@
77
## Documentation Overview
88

99
<!-- toc -->
10-
- [Project Readme and Quickstart][scb-github]
11-
- [User Guide](user-guide/README.md)
12-
- [Developer Guide](developer-guide/README.md)
10+
- [Project Readme and Quickstart][scb-github] Start here if you want to get a brief overview and installation quickstart
11+
- [User Guide](user-guide/README.md) If you want to configure security automation in your environment, please take a look into our user guide.
12+
- [Developer Guide](developer-guide/README.md) If you want to extend the project an add your own compents or bugfix something, please take a look into our developer guide.
13+
- [Glossary](glossary.md) This overview provides a description for all acronyms and special terms which are used in this project.
14+
- [Versioning](versioning.md) This describes how we use versioning in tags and releases.
1315

1416
<!-- tocstop -->
1517

1618
## Need a human?
17-
- [Join Slack][scb-slack]
19+
- [Join us -> Slack][scb-slack] 💬
1820

1921
## License
2022
Code of secureCodeBox is licensed under the [Apache License 2.0][scb-license].

docs/user-guide/CLI.md

Whitespace-only changes.

docs/user-guide/Hooks.md

Whitespace-only changes.

0 commit comments

Comments
 (0)