Skip to content

Commit 67c8a4a

Browse files
authored
Minor refactor of Outcome and Overview documentation (#972)
2 parents a220ed4 + d437264 commit 67c8a4a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+235
-197
lines changed

data/schema/v2/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44

55
We are now automatically generating the schema files for SSVC based on their
66
corresponding Pydantic models. This allows us to keep the schema files in sync
7-
with the code more easily. However, it required us to make some changes to the
8-
file names. So we've left behind some soft links from the original file names
9-
to help ease the transition.
7+
with the code more easily. However, it required us to make some changes to the
8+
file names. So we've left behind some soft links from the original file names
9+
to help ease the transition.

docs/adr/0013-ssvc-project-versions.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ For the overall SSVC project and documentation, we need a scheme that better ref
2929
- **Patch** = subsequent updates in the same month or smaller corrections
3030

3131
**Significant updates** include:
32+
3233
- Adding or restructuring sections in ways that affect usability
3334
- Adding/revising decision points, tables, or other SSVC objects
3435
- Adding features that change how SSVC is applied
@@ -39,6 +40,7 @@ Months use single digits (`2025.6`) to keep versions concise.
3940
## Rationale
4041

4142
CalVer suits SSVC’s character as a living framework:
43+
4244
- Clearly signals recency (date in the version number)
4345
- Fits both documentation-focused and object-focused updates
4446
- Avoids SemVer debates over what counts as “major” or “minor”
@@ -61,6 +63,7 @@ The CalVer scheme will be applied via Git tags and GitHub releases.
6163
## Alternatives Rejected
6264

6365
**Continue SemVer for project/docs**
66+
6467
- **Good:** Maintains continuity
6568
- **Bad:** Cannot easily express documentation updates independent of object versions
6669

docs/howto/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
- An interest in using SSVC in a vulnerability management process
88
- Basic familiarity with SSVC
99

10-
If you are unfamiliar with SSVC, we suggest you start with the [Learning SSVC](../tutorials/index.md) section.
10+
If you are unfamiliar with SSVC, we suggest you start with the [SSVC Overview](../tutorials/ssvc_overview.md) section.
1111
[Understanding SSVC](../topics/index.md) provides necessary background detail.
1212
For technical reference, see [Reference](../reference/index.md).
1313

docs/howto/tools/containers.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,4 +50,3 @@ docker-compose --project-directory=docker up api
5050
```
5151

5252
Then browse to `http://localhost:8001/docs` to access the API documentation.
53-

docs/howto/using_epss/epss_percentiles.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,6 @@ the prioritization of vulnerabilities based on their EPSS percentiles.
160160
This way, even if multiple vulnerabilities fall into the same SSVC category,
161161
you can still prioritize them based on their predicted likelihood of exploitation.
162162

163-
164163
## Conclusion
165164

166165
In this how-to, we've demonstrated how to use EPSS percentiles as an amplifier

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ We have organized the SSVC documentation into four main sections:
1010

1111
<div class="grid cards" markdown>
1212

13-
- :fontawesome-regular-eye:{ .lg .middle } [**SSVC Overview**](ssvc_overview.md)
13+
- :fontawesome-regular-eye:{ .lg .middle } [**SSVC Overview**](tutorials/ssvc_overview.md)
1414

1515
---
1616

1717
A beginner's guide to SSVC.
1818
This section is for people who have never heard of SSVC.
1919

20-
[:octicons-arrow-right-24: An Overview of SSVC](ssvc_overview.md)
20+
[:octicons-arrow-right-24: An Overview of SSVC](tutorials/ssvc_overview.md)
2121

2222
- :material-clipboard-check:{ .lg .middle } [**SSVC How To**](howto/index.md)
2323

docs/reference/code/decision_point_groups.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Decision Point groups provide collections of related Decision Points for some
44
specific purpose.
55

6-
With the introduction of [Decision Tables](decision_tables.md),
6+
With the introduction of [Decision Tables](decision_tables.md),
77
Decision Point groups are less important than they once were, and may be
88
removed in a future release.
99
However, they can still be useful for documentation and
@@ -17,4 +17,4 @@ for some programmatic uses.
1717

1818
## CVSS Decision Point Groups
1919

20-
::: ssvc.dp_groups.cvss.collections
20+
::: ssvc.dp_groups.cvss.collections

docs/reference/code/decision_points.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@
44

55
::: ssvc.decision_points.base
66

7-
::: ssvc.decision_points.helpers
7+
::: ssvc.decision_points.helpers

docs/reference/code/decision_tables.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@
44

55
::: ssvc.decision_tables.base
66

7-
::: ssvc.decision_tables.helpers
7+
::: ssvc.decision_tables.helpers

docs/reference/code/index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
# SSVC Code Documentation
22

33
This section provides documentation for the SSVC Python modules.
4+
45
These include:
56

6-
- [Decision Points](decision_points.md) and [Outcomes](outcomes.md)
7+
- [Decision Points](decision_points.md)
78
- [Decision Tables](decision_tables.md)
9+
- [Decision Point Groups](decision_point_groups.md) (Deprecated)
10+
- [Namespaces](namespaces.md)
11+
- [Selections](selection.md)
812
- [CSV Analyzer](analyze_csv.md)
913
- [Policy Generator](policy_generator.md)
1014
- [Namespaces](namespaces.md)

0 commit comments

Comments
 (0)