You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 80a1a3d
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/new_hook.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,13 +26,13 @@ Before opening a new issue, please make sure that we do not have any duplicates
26
26
27
27
## Steps to implement a new Hook
28
28
<!--
29
-
Hint: A general guide how to implement a new scanner is documented [here](https://github.com/secureCodeBox/secureCodeBox-v2/tree/master/docs/developer-guide)
29
+
Hint: A general guide how to implement a new scanner is documented [here](https://github.com/secureCodeBox/secureCodeBox/tree/master/docs/developer-guide)
30
30
-->
31
31
32
-
-[ ] Create a new folder with the name of the [hook here](https://github.com/secureCodeBox/secureCodeBox-v2/tree/master/hooks)
32
+
-[ ] Create a new folder with the name of the [hook here](https://github.com/secureCodeBox/secureCodeBox/tree/master/hooks)
33
33
-[ ] Add a README and give a brief overview of the scanner and its configuration options.
34
34
-[ ] Add (optional) a Dockerfile for the scanner if there is no existing one publicly available on dockerHub
35
-
-[ ] Use the [Hook-SDK](https://github.com/secureCodeBox/secureCodeBox-v2/tree/master/hook-sdk) to implement a new hook (currently based on NodeJS)
35
+
-[ ] Use the [Hook-SDK](https://github.com/secureCodeBox/secureCodeBox/tree/master/hook-sdk) to implement a new hook (currently based on NodeJS)
36
36
-[ ] Add unit tests with at minimum 80% test coverage
37
37
-[ ] Add some example scan.yaml and finding.yaml files in the example folder
38
-
-[ ] Implement a new integration test for the hook [here](https://github.com/secureCodeBox/secureCodeBox-v2/tree/master/tests/integration)
38
+
-[ ] Implement a new integration test for the hook [here](https://github.com/secureCodeBox/secureCodeBox/tree/master/tests/integration)
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/new_security_scanner.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,14 +26,14 @@ Before opening a new issue, please make sure that we do not have any duplicates
26
26
27
27
## Steps to implement a new scanner
28
28
<!--
29
-
Hint: A general guide how to implement a new scanner is documented [here](https://github.com/secureCodeBox/secureCodeBox-v2/tree/master/docs/developer-guide)
29
+
Hint: A general guide how to implement a new scanner is documented [here](https://github.com/secureCodeBox/secureCodeBox/tree/master/docs/developer-guide)
30
30
-->
31
31
32
-
-[ ] Create a new folder with the name of the [scanner here](https://github.com/secureCodeBox/secureCodeBox-v2/tree/master/scanners)
32
+
-[ ] Create a new folder with the name of the [scanner here](https://github.com/secureCodeBox/secureCodeBox/tree/master/scanners)
33
33
-[ ] Add a README.md and give a brief overview of the scanner and its configuration options.
34
34
-[ ] Implement a new scanner specific scan-type.yaml
35
35
-[ ] Implement a new scanner specific parse-definition.yaml
36
36
-[ ] Add (optional) some cascading-rules.yaml
37
37
-[ ] Add (optional) a Dockerfile for the scanner if there is no existing one publicly available on dockerHub
38
-
-[ ] Use the [parser-SDK](https://github.com/secureCodeBox/secureCodeBox-v2/tree/master/parser-sdk) to implement a new findings parser (currently based on NodeJS)
38
+
-[ ] Use the [parser-SDK](https://github.com/secureCodeBox/secureCodeBox/tree/master/parser-sdk) to implement a new findings parser (currently based on NodeJS)
39
39
-[ ] Add unit tests with at minimum 80% test coverage
**NOTE**: This Repository contains the stable beta preview of the next major secureCodeBox (SCB) Release v2.
23
-
You can find the current **stable release** here [https://github.com/secureCodeBox/secureCodeBox](https://github.com/secureCodeBox/secureCodeBox).
24
-
25
22
_The major release of SCB version 2.0 will be available in the next weeks._ The release will contain a major architecture change which will not be backward compatible. More details will follow soon in a series of blog articles.
26
23
27
24
> _secureCodeBox_ is a kubernetes based, modularized toolchain for continuous security scans of your software project. Its goal is to orchestrate and easily automate a bunch of security-testing tools out of the box.
@@ -30,29 +27,15 @@ _The major release of SCB version 2.0 will be available in the next weeks._ The
Optionally deploy SCB scanner charts for each security scanner you want to use. They should not be installed into the `securecodebox-system` like the operator so that different teams can use different kinds of scanners.
- Port Forward Kibana: `kubectl port-forward -n default service/elkh-kibana 5601:5601`
171
-
- Port Forward Elasticsearch: `kubectl port-forward -n default service/elasticsearch-master 9200:9200`
172
-
173
-
## How does it work?
61
+
You can find resources to help you get started on our [documentation website](https://docs.securecodebox.io) including instruction on how to [install the secureCodeBox](https://docs.securecodebox.io/docs/getting-started/installation) and guides to help you [run your first scans](https://docs.securecodebox.io/docs/getting-started/first-scans) with it.
We want to introduce versioning to be able to provide dokumentation for multiple versions of the SecureCodeBox.
23
+
The tool that we are currently using for documentation is https://v2.docusaurus.io/[Docusaurus].
24
+
Docusaurus provides the possibility to maintain multiple versions out of the box (https://v2.docusaurus.io/docs/versioning/[]).
25
+
26
+
We will need to specify how many versions of the documentation we want to maintain to avoid inconsistencies and overhead.
27
+
Furthermore, we need to decide which version increments need to have their own branch of documentation.
28
+
29
+
== Decision
30
+
31
+
* We introduce a new documentation version for every minor version (https://semver.org/[]) to ensure that the documentation is up to date
32
+
* We maintain the latest 3 major versions (previous, current, next)
33
+
* We maintain the latest minor version for each major version
34
+
* We *do not* maintain patch versions nor multiple minor versions for each major version!
35
+
* *Example:* For SecureCodeBox versions `1.9.9`, `2.3.2`, `2.3.3` and `3.0.0` the documentation versions would be `1.9.x`, `2.3.x` and `3.0.x`
36
+
* *TL;DR* We maintain 3 versions of the documentation
37
+
38
+
== Consequences
39
+
40
+
* We need to update the documentation version everytime we increment minor or major versions of the SecureCodeBox (manually or with action)
41
+
* Maintaining the documentation could be more difficult due to now increased number of documentation files
42
+
* Documentation has to be maintained in two repositories because when creating a new version Docusaurus creates a copy of all files in this respository (see https://v2.docusaurus.io/docs/versioning/#directory-structure[])
0 commit comments