Skip to content

Moved Upgrading.md to the documentation website #2915

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
J12934 merged 3 commits into from
Feb 21, 2025
Merged

Moved Upgrading.md to the documentation website #2915

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
845031c
Moved Upgrading.md to be in the documentation website
Ilyesbdlala Feb 21, 2025
0f572aa
Fix path in upgrading documentation for correct navigation
Ilyesbdlala Feb 21, 2025
3088fe5
Update links in label-commenter-config and README for upgrading docum…
Ilyesbdlala Feb 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/label-commenter-config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
16 changes: 10 additions & 6 deletions UPGRADING.md → ...ntation/docs/getting-started/upgrading.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
<!--
SPDX-FileCopyrightText: the secureCodeBox authors
---
# SPDX-FileCopyrightText: the secureCodeBox authors
#
# SPDX-License-Identifier: Apache-2.0

SPDX-License-Identifier: Apache-2.0
-->

# Upgrading
title: "Upgrading secureCodeBox"
sidebar_label: Upgrading
path: "docs/getting-started/upgrading"
sidebar_position: 3

---
## From 2.X to 3.X

### Upgraded Kubebuilder Version to v3
Expand Down Expand Up @@ -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

Expand Down
Loading