Skip to content

Commit ef798da

Browse files
committed
updated summary table
Signed-off-by: Eddie Knight <knight@linux.com>
1 parent ede2d01 commit ef798da

File tree

8 files changed

+13
-26
lines changed

8 files changed

+13
-26
lines changed

content/en/docs/_index.md

Lines changed: 8 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,30 +12,17 @@ description: >
1212

1313
Privateer is a validation framework that simplifies infrastructure testing and compliance validation. Built with infrastructure engineers in mind, Privateer helps you validate resources against regulations, taxonomies, and standards.
1414

15-
## Key Concepts
16-
17-
Privateer is built on several key concepts that work together to provide comprehensive validation:
18-
19-
| Concept | Description | Icon |
20-
|---------|-------------|------|
21-
| **Privateer Core** | An executable test harness that calls plugins based on the user's configuration | <img src="/images/patches-small.png" alt="Privateer Core" width="80"> |
22-
| **Privateer SDK** | A set of logic and tools used to establish efficient, secure, and cohesive collaboration between Privateer and its Plugins | <img src="/images/sdk.svg" alt="SDK" width="80"> |
23-
| **Plugin** | Responsible for executing validation tests and returning results to Privateer | <img src="/images/plugin.svg" alt="Plugin" width="80"> |
24-
| **EvaluationSuite** | Maps to control catalogs, following the "Simplified Compliance Infrastructure" model | <img src="/images/testSuite.svg" alt="Test Suite" width="80"> |
25-
| **Test Set** | A collection of related tests within an EvaluationSuite | <img src="/images/testSet.svg" alt="Test Set" width="80"> |
26-
| **Test** | Individual validation test within a Test Set | <img src="/images/test.svg" alt="Test" width="80"> |
27-
28-
## Key Features
29-
3015
- **Community-Driven Plugins**: Plugins are crafted and maintained collaboratively by the community
3116
- **Comprehensive Resource Validation**: Validate diverse resources in a single execution
3217
- **Consistent Machine-Readable Output**: Standardized output simplifies automation and integration
3318
- **Empowering Service Providers**: Certify resources for use in regulated industries
3419

35-
## Documentation Sections
36-
37-
### [For Users](/docs/users/)
38-
Learn how to install and use Privateer to validate your infrastructure resources.
20+
Privateer is built on several key concepts that work together to provide comprehensive validation:
3921

40-
### [For Developers](/docs/developers/)
41-
Learn how to develop plugins and use the Privateer SDK.
22+
| | | |
23+
|---|---|---|
24+
| <img src="/images/anvil.svg" alt="anvil" width="100"> | Privateer SDK | provides common logic for Privateer and Plugins |
25+
| <img src="/images/ship.svg" alt="ship" width="100" height="100"> | Privateer Core | the main executable that runs plugins based on user configuration |
26+
| <img src="/images/map.svg" alt="map" width="100"> | Plugin | execute validation tests and return results to Privateer |
27+
| <img src="/images/cannon.svg" alt="cannon" width="100"> | EvaluationSuite | a set of related data allowing control IDs and their requirements to be mapped to one or more assessment steps |
28+
| <img src="/images/match.svg" alt="match" width="100"> | AssessmentStep | a specialized function which will analyze a data payload provided at runtime |

content/en/docs/developers/plugins/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: >
88

99
## Generating a Plugin
1010

11-
<img src="/images/plugin.svg" alt="Plugin" style="float: right; max-width: 120px; margin: 0 0 20px 20px;">
11+
<img src="/images/map.svg" alt="Plugin" style="float: right; max-width: 120px; margin: 0 0 20px 20px;">
1212

1313
Privateer includes a command to generate a plugin from a YAML controls catalog document that complies with the [Gemara](https://gemara.openssf.org) Layer 2 schema.
1414

@@ -70,19 +70,19 @@ A typical Privateer plugin includes the following components, organized hierarch
7070

7171
<div style="display: flex; flex-wrap: wrap; gap: 20px; margin: 20px 0; align-items: center;">
7272
<div style="text-align: center;">
73-
<img src="/images/plugin.svg" alt="Plugin" width="100">
73+
<img src="/images/map.svg" alt="Plugin" width="100">
7474
<p><strong>Plugin</strong></p>
7575
</div>
7676
<div style="text-align: center;">
77-
<img src="/images/testSuite.svg" alt="EvaluationSuite" width="100">
77+
<img src="/images/cannon.svg" alt="EvaluationSuite" width="100">
7878
<p><strong>EvaluationSuite</strong></p>
7979
</div>
8080
<div style="text-align: center;">
8181
<img src="/images/testSet.svg" alt="Test Set" width="100">
8282
<p><strong>Test Set</strong></p>
8383
</div>
8484
<div style="text-align: center;">
85-
<img src="/images/test.svg" alt="Test" width="100">
85+
<img src="/images/match.svg" alt="Test" width="100">
8686
<p><strong>Test</strong></p>
8787
</div>
8888
</div>

content/en/docs/developers/sdk/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: >
88

99
## Privateer SDK
1010

11-
<img src="/images/sdk.svg" alt="Privateer SDK" style="float: right; max-width: 120px; margin: 0 0 20px 20px;">
11+
<img src="/images/anvil.svg" alt="Privateer SDK" style="float: right; max-width: 120px; margin: 0 0 20px 20px;">
1212

1313
The Privateer SDK provides the interface and utilities needed for plugin development:
1414

0 commit comments

Comments
 (0)