Skip to content

Commit

Permalink
Merge pull request #539 from jhkrug/active-introductory
Browse files Browse the repository at this point in the history
CNCF recommendations - Introductory pages review for active voice, language and some formatting.
  • Loading branch information
flavio authored Feb 4, 2025
2 parents ee11251 + 2c88bf7 commit 69ca291
Show file tree
Hide file tree
Showing 4 changed files with 158 additions and 116 deletions.
31 changes: 15 additions & 16 deletions docs/disclosure.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,37 +13,36 @@ doc-topic: [security, disclosure]
<link rel="canonical" href="https://docs.kubewarden.io/disclosure"/>
</head>

The Kubewarden team greatly appreciates investigative work into security
The Kubewarden team appreciates investigative work on security
vulnerabilities carried out by well-intentioned, ethical security researchers.
We follow the practice of [responsible
disclosure](https://en.wikipedia.org/wiki/Responsible_disclosure) in order to
best protect Kubewarden's user-base from the impact of security issues. On our
side, this means:

- We will respond to security incidents on priority.
- We will release fixes for issues as soon as is practical, keeping in mind
that not all risks are created equal.
- We will always transparently let the community know about any incident that
Kubewarden follows the practice of [responsible
disclosure](https://en.wikipedia.org/wiki/Responsible_disclosure) to
best protect Kubewarden's user base from the impact of security issues. On
Kubewarden's side, this means:

- Kubewarden responds to security incidents on priority.
- Kubewarden releases fixes for issues as soon as is practical, prioritizing by risk.
- Kubewarden always transparently lets the community know about any incident that
affects them.

If you have found a security vulnerability in Kubewarden, the easiest way to
report a vulnerability is through the [Security tab on
GitHub](https://github.com/kubewarden/community/security/advisories). This
mechanism allows maintainers to communicate privately with you, and you do not
mechanism allows maintainers to communicate privately with you, and you don't
need to encrypt your messages.

Alternatively, you can can disclose it responsibly by emailing
Alternatively, you can disclose it responsibly by emailing
[cncf-kubewarden-maintainers@lists.cncf.io](mailto:cncf-kubewarden-maintainers@lists.cncf.io)
in an **unencrypted** message. Please do not discuss potential vulnerabilities in public without validating
with us first.

You can also come talk to us at our [slack-room] in the Kubernetes Slack server.
You can also come talk in our [slack-room] on the Kubernetes Slack server.

On receipt the security team will:
On receipt, the security team:

- Review the report, verify the vulnerability and respond with confirmation
- Reviews the report, verifies the vulnerability and responds with confirmation
and/or further information requests.
- Once the reported security bug has been addressed we will notify the
- After addressing the reported security bug, Kubewarden notifies the
Researcher, who is then welcome to optionally disclose publicly.

Please, refer to the [community
Expand Down
23 changes: 10 additions & 13 deletions docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ Kubewarden offers flexibility for policy admission and enforcement in a Kubernet

## New to Kubewarden?

If new to the Kubewarden project start with the [Quick start guide](./quick-start.md)
If new to the Kubewarden project start with the
[Quick start guide](./quick-start.md)
and the [architecture](./explanations/architecture.md) page.
Then it depends where your interests take you.
For policy developers there are language specific sections in the tutorials.
Expand All @@ -61,10 +62,9 @@ As stated on [WebAssembly's official website](https://webassembly.org/):
> compilation target for programming languages, enabling deployment on
> the web for client and server applications.
Wasm was originally conceived as a browser "extension".
However, efforts are being made by the WebAssembly
community to allow the execution of Wasm code outside
browsers.
Wasm was originally conceived as a browser "extension". However, the
WebAssembly community is engaged in efforts to allow the execution of Wasm code
outside browsers.

## Why use WebAssembly?

Expand All @@ -77,15 +77,12 @@ architecture and operating system.
For example, a policy developed and built on Apple Silicon can run on
AMD64/Intel64 Linux without conversion.

Policy authors can reuse their skills, tools and best
practices. Policies are "traditional" programs that can have reusable
blocks (regular libraries), can be linted and tested, and be
plugged into current CI and CD workflows.
Policy authors can reuse their skills, tools and best practices. Policies are
"traditional" programs that can have reusable blocks (regular libraries). You
can lint and test them and you can plug them into current CI and CD workflows.

## Policy distribution

Kubewarden policies can be served by a regular web server or,
better, be published from an OCI compliant registry.

Kubewarden policies can be stored inside an OCI compliant registry as
You can serve Kubewarden policies using a standard web server or, better, you
can be publish them in an OCI compliant registry as
[OCI artifacts](https://github.com/opencontainers/artifacts).
1 change: 0 additions & 1 deletion docs/personas.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ doc-topic: [explanation]
<link rel="canonical" href="https://docs.kubewarden.io/personas"/>
</head>

<!-- prettier-ignore -->
|Persona|Description|
|-|-|
|**Policy user**|Someone who takes a policy and uses it in a cluster. They deploy policies and observe results. They configure the policy settings but don't write the policy internal code (if there is any).|
Expand Down
Loading

0 comments on commit 69ca291

Please sign in to comment.