Skip to content
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.

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

docs: unhyphenate open source #4284

Merged
merged 1 commit into from
Oct 15, 2024
Merged

docs: unhyphenate open source #4284

merged 1 commit into from
Oct 15, 2024

Conversation

lennessyy
Copy link
Contributor

@lennessyy lennessyy commented Oct 15, 2024

Describe the Change

This PR un-hyphenate open source.

Changed Pages

💻 Add Preview URL for Page

Jira Tickets

🎫 DOC-1413

Backports

Can this PR be backported?

  • Yes.

@lennessyy lennessyy added backport-version-4-0 Backport change to version 4.0 auto-backport Enable backport backport-version-3-4 Backport change to version 3.4 backport-version-4-1 Backport change to version 4.1 backport-version-4-2 Backport change to version 4.2 backport-version-4-3 Backport change to version 4.3 backport-version-4-4 Backport change to version 4.4 backport-version-4-5 Backport changes to the version-4-5 branch. labels Oct 15, 2024
Copy link

netlify bot commented Oct 15, 2024

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit 781cb2f
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/670ed366c8daaa0008ef58f3
😎 Deploy Preview https://deploy-preview-4284--docs-spectrocloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@lennessyy lennessyy marked this pull request as ready for review October 15, 2024 20:41
@lennessyy lennessyy requested a review from a team as a code owner October 15, 2024 20:41
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

docs/docs-content/clusters/edge/site-deployment/deploy-custom-registries/webhook-disable.md|174 col 82| [write-good.ThereIs] Don't start a sentence with 'There are'.
docs/docs-content/clusters/data-center/maas/architecture.md|14 col 48| [Vale.Terms] Use 'cloud' instead of 'Cloud'.
docs/docs-content/automation/crossplane/crossplane.md|10 col 34| [Vale.Terms] Use 'cloud' instead of 'Cloud'.

@@ -10,7 +10,7 @@ logoUrl: "https://registry.dev.spectrocloud.com/v1/kubehunter/blobs/sha256:6b6b9
tags: ["packs", "kube-hunter", "security"]
---

Kube Hunter is an open-source tool that hunts for security issues in your Kubernetes clusters. It’s designed to increase
Kube Hunter is an open source tool that hunts for security issues in your Kubernetes clusters. It’s designed to increase
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Kube'?

@@ -161,7 +161,7 @@ Toggle the **Enable** button to enable the use of Ingress.

#### Thanos SideCar

[Thanos](https://prometheus-operator.dev/docs/platform/thanos/) is an open-source system for running large-scale,
[Thanos](https://prometheus-operator.dev/docs/platform/thanos/) is an open source system for running large-scale,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.ableism] Avoid using ableism terms. Use 'operating' instead of 'running'.

@@ -382,7 +382,7 @@ Toggle the **Enable** button to enable the use of Ingress.

#### Thanos SideCar

[Thanos](https://prometheus-operator.dev/docs/platform/thanos/) is an open-source system for running large-scale,
[Thanos](https://prometheus-operator.dev/docs/platform/thanos/) is an open source system for running large-scale,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.ableism] Avoid using ableism terms. Use 'operating' instead of 'running'.

@@ -603,7 +603,7 @@ Toggle the **Enable** button to enable the use of Ingress.

#### Thanos SideCar

[Thanos](https://prometheus-operator.dev/docs/platform/thanos/) is an open-source system for running large-scale,
[Thanos](https://prometheus-operator.dev/docs/platform/thanos/) is an open source system for running large-scale,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.ableism] Avoid using ableism terms. Use 'operating' instead of 'running'.

@@ -824,7 +824,7 @@ Toggle the **Enable** button to enable the use of Ingress.

#### Thanos SideCar

[Thanos](https://prometheus-operator.dev/docs/platform/thanos/) is an open-source system for running large-scale,
[Thanos](https://prometheus-operator.dev/docs/platform/thanos/) is an open source system for running large-scale,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.ableism] Avoid using ableism terms. Use 'operating' instead of 'running'.

@@ -31,25 +31,25 @@ Review our [Maintenance Policy](maintenance-policy.md) to learn about pack updat

## What is PXK?

Palette eXtended Kubernetes (PXK) is a recompiled version of the open-source Cloud Native Computing Foundation (CNCF)
Palette eXtended Kubernetes (PXK) is a recompiled version of the open source Cloud Native Computing Foundation (CNCF)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'cloud' instead of 'Cloud'.

applied hardening of the operating system (OS) and Kubernetes. The hardening ranges from removing unused kernel modules
to using an OS configuration that follows industry best practices. Our recompiled Kubernetes configuration addresses
common Kubernetes deployment security pitfalls and implements industry best practices.

A benefit of Palette when used with PXK is the ability to apply different flavors of container storage interface (CSI)
plugins and container network interface (CNI) plugins. Other open-source Kubernetes distributions, such as MicroK8s,
plugins and container network interface (CNI) plugins. Other open source Kubernetes distributions, such as MicroK8s,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.acronym] Use title case to define the acronym '(CNI)'.

RKE2, and K3s, come with a default CSI and CNI. Additional complexity and overhead are required from you to enable
different interfaces. PXK supports the ability to select other interface plugins out of the box without any additional
overhead or complexity needed from your side.

There are no changes to the Kubernetes source code and we also follow the same versioning schema as the upstream
open-source Kubernetes distribution.
There are no changes to the Kubernetes source code and we also follow the same versioning schema as the upstream open
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[write-good.ThereIs] Don't start a sentence with 'There are'.

@@ -38,7 +38,7 @@ page for guidance on how to upload the conformance packs to the self-hosted OCI
This scan examines the compliance of deployed Kubernetes security features against the CIS Kubernetes Benchmarks. CIS
Kubernetes Benchmarks are consensus-driven security guidelines for the Kubernetes. Different releases of the CIS
benchmark cover different releases of Kubernetes. By default, Kubernetes configuration security will determine the test
set based on the Kubernetes version running on the cluster being scanned. Internally, Palette leverages an open-source
set based on the Kubernetes version running on the cluster being scanned. Internally, Palette leverages an open source
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.ableism] Avoid using ableism terms. Use 'operating' instead of 'running'.

@@ -100,7 +100,7 @@ and choose the desired SBOM format, scan scope, and an optional backup location.

Palette will identify every unique container image within your chosen scope and generate an SBOM for that image. Palette
also runs the SBOM through a vulnerability scanner to flag any Common Vulnerabilities and Exposures (CVEs). Palette
leverages two open-source tools from Anchore: [Syft](https://github.com/anchore/syft) for SBOM generation and
leverages two open source tools from Anchore: [Syft](https://github.com/anchore/syft) for SBOM generation and
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Anchore'?

Copy link
Contributor

@karl-cardenas-coding karl-cardenas-coding left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved 😄

@lennessyy lennessyy merged commit f4cbbb8 into master Oct 15, 2024
29 checks passed
@lennessyy lennessyy deleted the DOC-1413 branch October 15, 2024 22:00
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Oct 15, 2024
Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
(cherry picked from commit f4cbbb8)
@vault-token-factory-spectrocloud
Copy link
Contributor

💔 Some backports could not be created

Status Branch Result
version-4-0 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-0:
- chore: PAC-938-packs data initial fetch and component development for readme (#3178)
- docs: highlight CIS hardening (#3034)
- docs: DOC-1118 Image Conversion to webp (#2439)
- chore: add vale rule to enforce colon usage (#2441)
- Refactor/restructure cluster & app profiles sections (#1551)
- docs: updated URLs to use file path context
version-3-4 Backport failed because of merge conflicts

You might need to backport the following PRs to version-3-4:
- chore: PAC-938-packs data initial fetch and component development for readme (#3178)
- docs: highlight CIS hardening (#3034)
- chore: DOC-1148 fix missing trailing slash (#2656)
- docs: DOC-1118 Image Conversion to webp (#2439)
- chore: add vale rule to enforce colon usage (#2441)
- docs: self-Hosted guidance for nginx (#1722)
- Refactor/restructure cluster & app profiles sections (#1551)
- docs: refactor for self-hosted Palette DOC-465 (#1597)
- Tiny doc fixes for edge (#1603)
- docs: remove warning label docs
version-4-1 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-1:
- chore: PAC-938-packs data initial fetch and component development for readme (#3178)
- docs: highlight CIS hardening (#3034)
- docs: DOC-1118 Image Conversion to webp (#2439)
- chore: add vale rule to enforce colon usage (#2441)
- User Data Netplan (#1705)
version-4-2 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-2:
- chore: PAC-938-packs data initial fetch and component development for readme (#3178)
- docs: highlight CIS hardening (#3034)
- docs: fix userdata indentation (#2784)
- docs: DOC-1118 Image Conversion to webp (#2439)
- chore: add vale rule to enforce colon usage (#2441)
- docs: add instructions for connecting edge host to wifi (#2092)
- replace caution with warning (#2039)
version-4-3 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-3:
- chore: PAC-938-packs data initial fetch and component development for readme (#3178)
version-4-4 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-4:
- docs: DOC-1385 (#4047)
- docs: 9-23-24 cve updates (#4046)
version-4-5

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

backport --pr 4284

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

vault-token-factory-spectrocloud bot added a commit that referenced this pull request Oct 15, 2024
Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
(cherry picked from commit f4cbbb8)

Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>
@vault-token-factory-spectrocloud
Copy link
Contributor

🎉 This issue has been resolved in version 4.5.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Enable backport backport-version-3-4 Backport change to version 3.4 backport-version-4-0 Backport change to version 4.0 backport-version-4-1 Backport change to version 4.1 backport-version-4-2 Backport change to version 4.2 backport-version-4-3 Backport change to version 4.3 backport-version-4-4 Backport change to version 4.4 backport-version-4-5 Backport changes to the version-4-5 branch. released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants