From 845031cf010c2fcb8b54e229b7a4eaafe600b9b9 Mon Sep 17 00:00:00 2001 From: Ilyes Ben Dlala Date: Fri, 21 Feb 2025 14:57:00 +0100 Subject: [PATCH 1/3] Moved Upgrading.md to be in the documentation website Signed-off-by: Ilyes Ben Dlala --- .../docs/getting-started/upgrading.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) rename UPGRADING.md => documentation/docs/getting-started/upgrading.md (97%) diff --git a/UPGRADING.md b/documentation/docs/getting-started/upgrading.md similarity index 97% rename from UPGRADING.md rename to documentation/docs/getting-started/upgrading.md index e1e1dad8c1..2e210f6a49 100644 --- a/UPGRADING.md +++ b/documentation/docs/getting-started/upgrading.md @@ -1,11 +1,15 @@ - -# Upgrading +title: "Upgrading secureCodeBox" +sidebar_label: Upgrading +path: "docs/getting-started/uninstallation" +sidebar_position: 3 +--- ## From 2.X to 3.X ### Upgraded Kubebuilder Version to v3 @@ -81,7 +85,7 @@ scanner: ➡️ [Reference: #484](https://github.com/secureCodeBox/secureCodeBox/pull/484) ### Added scanner.appendName to chart values -Using {{ .Release.name }} in the `nmap` HelmChart Name for `scanTypes` causes issues when using this chart as a dependency of another chart. All scanners HelmCharts already used a fixed name for the `scanType` they introduce, with one exception: the `nmap` scanner HelmChart. +Using `{{ .Release.name }}` in the `nmap` HelmChart Name for `scanTypes` causes issues when using this chart as a dependency of another chart. All scanners HelmCharts already used a fixed name for the `scanType` they introduce, with one exception: the `nmap` scanner HelmChart. The nmap exception was originally introduced to make it possible configure yourself an `nmap-privilidged` scanType, which is capable of running operating system scans which requires some higher privileges: https://www.securecodebox.io/docs/scanners/nmap#operating-system-scans From 0f572aa15a50839b74160e55191dcefc32ae060c Mon Sep 17 00:00:00 2001 From: Ilyes Ben Dlala Date: Fri, 21 Feb 2025 14:59:03 +0100 Subject: [PATCH 2/3] Fix path in upgrading documentation for correct navigation Signed-off-by: Ilyes Ben Dlala --- documentation/docs/getting-started/upgrading.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/docs/getting-started/upgrading.md b/documentation/docs/getting-started/upgrading.md index 2e210f6a49..3d9fc30acd 100644 --- a/documentation/docs/getting-started/upgrading.md +++ b/documentation/docs/getting-started/upgrading.md @@ -6,7 +6,7 @@ title: "Upgrading secureCodeBox" sidebar_label: Upgrading -path: "docs/getting-started/uninstallation" +path: "docs/getting-started/upgrading" sidebar_position: 3 --- From 3088fe5351cc57364346377a5ae3ba58bc791663 Mon Sep 17 00:00:00 2001 From: Ilyes Ben Dlala Date: Fri, 21 Feb 2025 15:42:06 +0100 Subject: [PATCH 3/3] Update links in label-commenter-config and README for upgrading documentation Signed-off-by: Ilyes Ben Dlala --- .github/label-commenter-config.yml | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/label-commenter-config.yml b/.github/label-commenter-config.yml index 34e9e954f7..01a66faef9 100644 --- a/.github/label-commenter-config.yml +++ b/.github/label-commenter-config.yml @@ -7,5 +7,5 @@ labels: labeled: pr: body: | - This pull request includes breaking changes. **Please make sure that you included the breaking changes and the steps required to upgrade in [UPGRADING.md](https://github.com/secureCodeBox/secureCodeBox/blob/main/UPGRADING.md)**. + This pull request includes breaking changes. **Please make sure that you included the breaking changes and the steps required to upgrade in [Upgrading](https://www.securecodebox.io/docs/getting-started/upgrading)**. :sparkles: Thank you for your contribution! :sparkles: diff --git a/README.md b/README.md index 351236d844..3e0dfd4cc4 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ You can find resources to help you get started on our [documentation website](ht ## Upgrading -For the steps required for upgrading your secureCodeBox installation, see [Upgrading](./UPGRADING.md). +For the steps required for upgrading your secureCodeBox installation, see [Upgrading](https://www.securecodebox.io/docs/getting-started/upgrading). ## License