From 9dd0f67dcb25c82a91d70cdd26eb4dbc32d0adae Mon Sep 17 00:00:00 2001 From: Tobias Brixen Date: Mon, 18 Mar 2024 13:32:45 +0100 Subject: [PATCH 1/4] Fix inline code highlight Signed-off-by: Tobias Stenby Brixen --- documentation/docs/auto-discovery/service-auto-discovery.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/docs/auto-discovery/service-auto-discovery.md b/documentation/docs/auto-discovery/service-auto-discovery.md index ff3f02cb3a..a9ef08c247 100644 --- a/documentation/docs/auto-discovery/service-auto-discovery.md +++ b/documentation/docs/auto-discovery/service-auto-discovery.md @@ -9,7 +9,7 @@ path: "docs/auto-discovery/service-auto-discovery" sidebar_position: 2 --- -The Service AutoDiscovery will create a 'ScheduledScan` with the given parameters (see [readme](https://github.com/secureCodeBox/secureCodeBox/blob/main/auto-discovery/kubernetes/README.md) for config options) for each Kubernetes `Service` it detects. +The Service AutoDiscovery will create a `ScheduledScan` with the given parameters (see [readme](https://github.com/secureCodeBox/secureCodeBox/blob/main/auto-discovery/kubernetes/README.md) for config options) for each Kubernetes `Service` it detects. The Service AutoDiscovery will ignore services where the underlying pods do not serve http(s). It does this by checking for open ports `80, 443, 3000, 5000, 8000, 8443, 8080`. It is also sufficient to name the ports `http` or `https` when a different port is used than the ports specified above. Services without a matching port number or name are currently ignored. From 907358f5c8e937a261d2c8728cf773e2a20f6bbd Mon Sep 17 00:00:00 2001 From: Tobias Brixen Date: Mon, 18 Mar 2024 13:40:33 +0100 Subject: [PATCH 2/4] Add missing period Signed-off-by: Tobias Stenby Brixen --- .../docs/contributing/integrating-a-scanner/parser-dir.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/docs/contributing/integrating-a-scanner/parser-dir.md b/documentation/docs/contributing/integrating-a-scanner/parser-dir.md index cfee2b028f..0e6cd76205 100644 --- a/documentation/docs/contributing/integrating-a-scanner/parser-dir.md +++ b/documentation/docs/contributing/integrating-a-scanner/parser-dir.md @@ -11,7 +11,7 @@ This directory contains the parser for your scanner to transform the results of ## Dockerfile -For the parser we use multi-stage builds (see: [Multi-Stage Builds](https://www.docker.com/blog/multi-stage-builds/)) +For the parser we use multi-stage builds (see: [Multi-Stage Builds](https://www.docker.com/blog/multi-stage-builds/)). For our JavaScript Parser SDK the Dockerfile should look like this: ```dockerfile @@ -29,7 +29,7 @@ COPY --chown=app:app ./parser.js ./parser.js ``` If your parser does not require any external dependencies, A multi-stage build is not needed. -Instead, A simpler Dockerfile can be used. +Instead, a simpler Dockerfile can be used. ```dockerfile ARG namespace @@ -69,7 +69,7 @@ Your `package.json` should look something like this: ### Install The Dependencies -If you need additional dependencies you can install them via `npm install` +If you need additional dependencies you can install them via `npm install`. ### Write Your Parser From a7dd9edd4200d4a31bcb908f19773967a443c53d Mon Sep 17 00:00:00 2001 From: Tobias Brixen Date: Tue, 19 Mar 2024 08:15:18 +0100 Subject: [PATCH 3/4] Use lowercase a in headline Signed-off-by: Tobias Stenby Brixen --- .../contributing/integrating-a-hook/readme-and-helm-docs.md | 2 +- .../contributing/integrating-a-scanner/readme-and-helm-docs.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/docs/contributing/integrating-a-hook/readme-and-helm-docs.md b/documentation/docs/contributing/integrating-a-hook/readme-and-helm-docs.md index 3c7f931fb5..e19cd0bafb 100644 --- a/documentation/docs/contributing/integrating-a-hook/readme-and-helm-docs.md +++ b/documentation/docs/contributing/integrating-a-hook/readme-and-helm-docs.md @@ -3,7 +3,7 @@ # # SPDX-License-Identifier: Apache-2.0 -title: README.md And .helm-docs.gotmpl +title: README.md and .helm-docs.gotmpl sidebar_position: 7 --- diff --git a/documentation/docs/contributing/integrating-a-scanner/readme-and-helm-docs.md b/documentation/docs/contributing/integrating-a-scanner/readme-and-helm-docs.md index 4fe21b986e..c91ece4b49 100644 --- a/documentation/docs/contributing/integrating-a-scanner/readme-and-helm-docs.md +++ b/documentation/docs/contributing/integrating-a-scanner/readme-and-helm-docs.md @@ -3,7 +3,7 @@ # # SPDX-License-Identifier: Apache-2.0 -title: README.md And .helm-docs.gotmpl +title: README.md and .helm-docs.gotmpl sidebar_position: 9 --- From b233c6bdc89a32e9f1edc85b96309f56fcab3ec9 Mon Sep 17 00:00:00 2001 From: Tobias Stenby Brixen Date: Mon, 25 Mar 2024 21:35:14 +0100 Subject: [PATCH 4/4] Update CONTRIBUTORS.md Signed-off-by: Tobias Stenby Brixen --- CONTRIBUTORS.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index 57bed22441..0527f55c40 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -54,3 +54,4 @@ Committing with `git commit -s` will add the sign-off at the end of the commit m - Maximilian Dorner - Boris Shek - Kamiren Dawkins +- Tobias Stenby Brixen