Skip to content

Commit c107e1a

Browse files
authored
docs: rename governance to principles (aquasecurity#6107)
Signed-off-by: knqyf263 <[email protected]>
1 parent b26f217 commit c107e1a

File tree

2 files changed

+19
-5
lines changed

2 files changed

+19
-5
lines changed

docs/community/governance.md renamed to docs/community/principles.md

+18-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Trivy Project Governance
1+
# Trivy Project Principles
22
This document outlines the guiding principles and governance framework for the Trivy project.
33

44
## Core Principles
@@ -34,6 +34,20 @@ Trivy serves as a tool with opinions on security, used to warn users about poten
3434
Trivy is designed to detect unintended vulnerable states in projects, such as the use of vulnerable versions of dependencies or misconfigurations in Infrastructure as Code (IaC) that may unintentionally expose servers to the internet.
3535
The focus is on identifying developer mistakes or undesirable states, not on detecting intentional attacks, such as malicious images and malware.
3636

37-
## Governance Model
38-
The governance of Trivy is collaborative, valuing community input while recognizing Aqua Security's role in making final decisions.
39-
This model ensures that decisions, proposals, and enhancements align with Trivy's mission to provide a secure, simple, and independent security scanning solution, adhering to the project's core principles.
37+
## Out of Scope Features
38+
Aqua Security offers a premium version with several features not available in the open-source Trivy project.
39+
While detailed information can be found [here][trivy-aqua], it's beneficial to highlight specific functionalities frequently inquired about:
40+
41+
### Runtime Security
42+
As mentioned in [the Core Principles](#static-analysis-no-runtime-required), Trivy is a static analysis security scanner, making runtime security outside its scope.
43+
Runtime security needs are addressed by [Tracee][tracee] or [the commercial version of Aqua Security]().
44+
45+
### Intentional Attacks
46+
As mentioned in [the Core Principles](#detecting-unintended-states), detection of intentional attacks, such as malware or malicious container images, is not covered by Trivy and is supported in [the commercial version][aqua].
47+
48+
### User Interface
49+
Trivy primarily operates via CLI for displaying results, with a richer UI available in [the commercial version][aqua].
50+
51+
[trivy-aqua]: https://github.com/aquasecurity/resources/blob/main/trivy-aqua.md
52+
[tracee]: https://github.com/aquasecurity/tracee
53+
[aqua]: https://www.aquasec.com/

mkdocs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ nav:
178178
- Production and Clouds: ecosystem/prod.md
179179
- Reporting: ecosystem/reporting.md
180180
- Contributing:
181-
- Governance: community/governance.md
181+
- Principles: community/principles.md
182182
- How to contribute:
183183
- Issues: community/contribute/issue.md
184184
- Discussions: community/contribute/discussion.md

0 commit comments

Comments
 (0)