Skip to content

Commit

Permalink
minor clean up
Browse files Browse the repository at this point in the history
  • Loading branch information
ahouseholder committed Apr 24, 2024
1 parent e659185 commit e25cae2
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 27 deletions.
1 change: 0 additions & 1 deletion docs/reference/policy_templates/Receivers.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ or other organizations that receive vulnerability reports.

## Tips and Usage Notes

{% include-markdown "./_adjust_to_suit.md" %}
{% include-markdown "./_usage.md" %}
{% include-markdown "./_terminology.md" %}
{% include-markdown "./_consistency_warning.md" %}
Expand Down
1 change: 0 additions & 1 deletion docs/reference/policy_templates/Reporters.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ vulnerability disclosure program.<!--end-->

## Tips and Usage Notes

{% include-markdown "./_adjust_to_suit.md" %}
{% include-markdown "./_usage.md" %}
{% include-markdown "./_terminology.md" %}
{% include-markdown "./_consistency_warning.md" %}
Expand Down
14 changes: 0 additions & 14 deletions docs/reference/policy_templates/_adjust_to_suit.md

This file was deleted.

11 changes: 11 additions & 0 deletions docs/reference/policy_templates/_usage.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
!!! tip "How To Use These Templates"

Organizations will likely find that some expectations do not apply to their
situation based on the kind of stakeholder they are. In particular we anticipate
that
[product vendors](../../topics/roles/vendor.md),
[service providers](../../topics/roles/deployer.md),
and
[coordinators](../../topics/roles/coordinator.md) will have related but
distinct needs. Inclusion or exclusion of items from these templates into your
organization's policy should be based on which combination of stakeholder roles
you expect to play.

Here's a checklist of tasks you should complete in order to make use of these
templates.

Expand Down
11 changes: 0 additions & 11 deletions docs/reference/policy_templates/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ spawn a disclosure policy for an organization.
choose to adopt all of these items wholesale without some modification.


Check failure on line 24 in docs/reference/policy_templates/index.md

View workflow job for this annotation

GitHub Actions / lint

Multiple consecutive blank lines

docs/reference/policy_templates/index.md:24 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md012.md

- :material-feather: [Style Guide](./style_guide.md)

---
Expand All @@ -40,14 +39,4 @@ spawn a disclosure policy for an organization.

</div>


{% include-markdown "./_adjust_to_suit.md" %}
{% include-markdown "./_usage.md" %}

!!! note "Use of RFC 2119 Language"

We've taken the approach of using [RFC 2119](https://datatracker.ietf.org/doc/html/rfc2119)-style
"MUST, SHALL, SHOULD..." language in active-voice sentences to describe what researchers/reporters and
vendors/coordinators/recipients should expect of each other.


0 comments on commit e25cae2

Please sign in to comment.