Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New mkdocs+material site #18

Merged
merged 189 commits into from
Apr 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
189 commits
Select commit Hold shift + click to select a range
e1a50cf
add mkdocs setup
ahouseholder Feb 26, 2024
0d758b4
add pdf export
ahouseholder Feb 26, 2024
5c8ad92
add html exports
ahouseholder Feb 26, 2024
74017f0
update requirements.txt, add dependabot config
ahouseholder Feb 26, 2024
d109189
html to md conversion
ahouseholder Feb 26, 2024
af264f5
organize markdown content into folders
ahouseholder Feb 26, 2024
e8b2a85
organize markdown content into folders
ahouseholder Feb 26, 2024
6466d65
start renaming files
ahouseholder Feb 26, 2024
12264c6
strip out `:::` etc
ahouseholder Feb 26, 2024
42b3788
strip out `[Atlassian](https://www.atlassian.com/)`
ahouseholder Feb 26, 2024
fdd3dc4
strip out `Document generated by Confluence on <datetime>`
ahouseholder Feb 26, 2024
d364c12
strip out extraneous heading cruft
ahouseholder Feb 26, 2024
c9a6192
strip out extraneous `created by` cruft
ahouseholder Feb 26, 2024
4cad9f6
replace html links with md links
ahouseholder Feb 26, 2024
9cffdb8
add TODO to fix links
ahouseholder Feb 26, 2024
bf30991
remove non-header at top of files
ahouseholder Feb 26, 2024
813dd33
remove bottom of page links
ahouseholder Feb 26, 2024
9c4a094
compress blank lines
ahouseholder Feb 26, 2024
8450c0c
remove bottom of page links
ahouseholder Feb 26, 2024
1c19412
remove trailing slashes from line ends
ahouseholder Feb 26, 2024
1fa7aab
remove link styling
ahouseholder Feb 26, 2024
56cf02d
add pages to nav
ahouseholder Feb 26, 2024
dac70db
copy look and feel from SSVC
ahouseholder Feb 26, 2024
423eab5
add intro pages to nav
ahouseholder Feb 26, 2024
9f426bf
clean up overly escaped apostrophes
ahouseholder Feb 26, 2024
e21eafb
add full site page
ahouseholder Feb 26, 2024
54d4e3f
replace overly escaped double quotes
ahouseholder Feb 26, 2024
5b849b3
replace overly escaped single quotes
ahouseholder Feb 26, 2024
effeaa5
add roles to nav
ahouseholder Feb 26, 2024
7fd776f
remove trailing slashes from line ends
ahouseholder Feb 26, 2024
c6d3764
remove link style
ahouseholder Feb 26, 2024
af92b99
remove rel nofollows
ahouseholder Feb 26, 2024
ab386aa
remove rel nofollows
ahouseholder Feb 26, 2024
9b95986
remove id tags
ahouseholder Feb 26, 2024
6cd8441
strip out numbers from headers
ahouseholder Feb 26, 2024
ececb56
quick hit edits
ahouseholder Feb 26, 2024
41b7617
rename files
ahouseholder Feb 27, 2024
1c855c1
remove heading numbers
ahouseholder Feb 27, 2024
da6cec5
add operations section
ahouseholder Feb 27, 2024
906e92d
rename files
ahouseholder Feb 27, 2024
3f8874d
this document -> this documentation
ahouseholder Feb 27, 2024
1d1047a
quick edits
ahouseholder Feb 27, 2024
83ba4cf
add grid cards
ahouseholder Feb 27, 2024
1ab96f8
rename files
ahouseholder Feb 27, 2024
0e1bdfc
strip NBSPs
ahouseholder Feb 27, 2024
1c542df
add diataxis framework
ahouseholder Feb 27, 2024
cbec713
split off avoid_risk.md
ahouseholder Feb 27, 2024
28f823d
organizing docs
ahouseholder Feb 27, 2024
d864fd4
organizing docs
ahouseholder Feb 27, 2024
c07a0fa
formatting
ahouseholder Feb 27, 2024
87e5f71
formatting
ahouseholder Feb 27, 2024
d70a571
clean up
ahouseholder Feb 27, 2024
76e74e2
remove recent_changes.md
ahouseholder Feb 27, 2024
26a89a4
formatting
ahouseholder Feb 27, 2024
ab6d26e
formatting
ahouseholder Feb 27, 2024
c6b0c8b
add cert swoosh
ahouseholder Feb 28, 2024
6550482
rename appendices
ahouseholder Feb 28, 2024
56582b5
add recipe cards
ahouseholder Feb 28, 2024
bc41cf2
split recipe cards into files
ahouseholder Feb 28, 2024
e0244d8
add anchors
ahouseholder Feb 28, 2024
c254d4e
reorganize files to match nav
ahouseholder Feb 28, 2024
98050b8
link fixes
ahouseholder Feb 28, 2024
cdce638
cleaning up formatting
ahouseholder Feb 28, 2024
410e377
more copy edits
ahouseholder Feb 29, 2024
76a6eac
more copy edits
ahouseholder Feb 29, 2024
6465f5b
more copy edits
ahouseholder Feb 29, 2024
5f7078f
more copy edits
ahouseholder Feb 29, 2024
e74f85a
split pgp into separate file
ahouseholder Feb 29, 2024
39a132c
add tech analysis and monitoring
ahouseholder Mar 1, 2024
910a1c2
Bump the mkdocs group with 3 updates
dependabot[bot] Mar 1, 2024
081968c
Create main.yml
ahouseholder Mar 1, 2024
9b6bb1c
Update main.yml
ahouseholder Mar 1, 2024
e03b2fb
Merge branch 'dependabot/pip/mkdocs-eeac5f45eb' of https://github.com…
ahouseholder Mar 1, 2024
a70d50b
rename deploy_site.yml
ahouseholder Mar 1, 2024
8008dce
fix a bad search/replace
ahouseholder Mar 1, 2024
4c42abf
replace `---` with mdashes
ahouseholder Mar 1, 2024
860728d
Bump the mkdocs group with 1 update
dependabot[bot] Mar 4, 2024
3471da3
add google analytics
ahouseholder Mar 4, 2024
8239b93
Merge commit '860728d3e27c21e6217e0e7e3901cec5939d51a4' into staging/…
ahouseholder Mar 4, 2024
7cd4d98
add markdown lint configuration
ahouseholder Mar 6, 2024
2bae22b
markdownlint
ahouseholder Mar 6, 2024
323e6da
revise preface.md to mention AI/ML
ahouseholder Mar 6, 2024
3570c41
replace acronyms
ahouseholder Mar 6, 2024
69e33e9
inline ref
ahouseholder Mar 6, 2024
3bd20bb
add draft docs
ahouseholder Mar 6, 2024
c4ad681
add grid
ahouseholder Mar 6, 2024
96a35f4
clarify nav heading
ahouseholder Mar 6, 2024
e1409e1
add diagram, formatting
ahouseholder Mar 6, 2024
846fd48
Update issue templates
ahouseholder Mar 18, 2024
b4c6a89
Merge pull request #5 from CERTCC/ahouseholder-patch-1
ahouseholder Mar 18, 2024
f9d3360
update nav
ahouseholder Mar 18, 2024
1cc39fc
refactor TLP content
ahouseholder Mar 18, 2024
21e0f1b
revise sample vrf
ahouseholder Mar 18, 2024
14c49d6
modify branches for auto publish
ahouseholder Mar 19, 2024
47763cd
misc formatting
ahouseholder Mar 19, 2024
f9ecd84
fixes #71
ahouseholder Mar 19, 2024
6f234c1
Merge pull request #72 from CERTCC/71-page-tutorialstroubleshootingle…
ahouseholder Mar 19, 2024
455706e
Bump the mkdocs group with 2 updates
dependabot[bot] Mar 19, 2024
f68c1b5
fixes #68
ahouseholder Mar 19, 2024
6dcf69b
Merge pull request #73 from CERTCC/68-page-tutorialstroubleshootingge…
ahouseholder Mar 19, 2024
78a1116
Merge pull request #4 from CERTCC/dependabot/pip/mkdocs-8730912f6d
ahouseholder Mar 19, 2024
42df56e
fixes #69
ahouseholder Mar 19, 2024
732184a
Merge pull request #74 from CERTCC/69-page-tutorialstroubleshootinghy…
ahouseholder Mar 19, 2024
8ca612b
fixes #70
ahouseholder Mar 19, 2024
cfcbc15
Merge pull request #75 from CERTCC/70-page-tutorialstroubleshootingin…
ahouseholder Mar 19, 2024
01c3f70
fixes #67
ahouseholder Mar 19, 2024
4c70b8a
fix section links
ahouseholder Mar 19, 2024
01b6530
Merge pull request #76 from CERTCC/67-page-tutorialstroubleshootingcv…
ahouseholder Mar 19, 2024
6443462
add icons to grid cards
ahouseholder Mar 19, 2024
d74bff7
Merge pull request #77 from CERTCC/66-page-tutorialstroubleshooting-p…
ahouseholder Mar 19, 2024
da6a514
replace grid with diagram
ahouseholder Mar 20, 2024
12d2307
Merge pull request #78 from CERTCC/59-page-tutorialscvd_is_a_process-…
ahouseholder Mar 20, 2024
5420134
add tips to content
ahouseholder Mar 20, 2024
d8f1889
Merge pull request #79 from CERTCC/64-page-tutorialsrelationships_sid…
ahouseholder Mar 20, 2024
987c8b5
remove preview, integrate into tutorial intro
ahouseholder Mar 20, 2024
ff7e929
add icons
ahouseholder Mar 20, 2024
2398708
Merge pull request #80 from CERTCC/63-page-tutorialspreview-punchlist
ahouseholder Mar 20, 2024
8ef37ba
revise public awareness and publishing content
ahouseholder Mar 20, 2024
743cc33
fix references
ahouseholder Mar 20, 2024
60542cf
Merge pull request #81 from CERTCC/56-page-topicsrolesreporter-punchlist
ahouseholder Mar 20, 2024
d580a75
add tip
ahouseholder Mar 20, 2024
604fda7
Merge pull request #82 from CERTCC/58-page-tutorialsactive-exploitati…
ahouseholder Mar 20, 2024
230a5d5
add tip
ahouseholder Mar 20, 2024
187f608
Merge pull request #83 from CERTCC/47-page-topicsprinciplesavoid_surp…
ahouseholder Mar 20, 2024
2f15f8c
add flow chart
ahouseholder Mar 20, 2024
199051f
Merge pull request #84 from CERTCC/54-page-topicsrolesfinder-punchlist
ahouseholder Mar 20, 2024
0ba4cc7
convert list to tips
ahouseholder Mar 20, 2024
e850e96
Merge pull request #85 from CERTCC/61-page-tutorialsfind_vendor_conta…
ahouseholder Mar 20, 2024
c85cd67
split deployer process into a separate tutorial
ahouseholder Mar 20, 2024
e787149
Merge pull request #86 from CERTCC/53-page-topicsrolesdeployer-punchlist
ahouseholder Mar 20, 2024
de5d574
convert list to table
ahouseholder Mar 20, 2024
fa2fea8
Merge pull request #87 from CERTCC/51-page-topicsprincipleswicked_pro…
ahouseholder Mar 20, 2024
965f6ab
add mkdocs header info
ahouseholder Mar 20, 2024
44fa7ba
split vendor process into tutorial
ahouseholder Mar 20, 2024
6c50494
refactor deployer response process doc
ahouseholder Mar 20, 2024
f92c02d
add links
ahouseholder Mar 20, 2024
25041f8
add FIRST PSIRT
ahouseholder Mar 20, 2024
bc8154a
Merge pull request #88 from CERTCC/57-page-topicsrolesvendor-punchlist
ahouseholder Mar 20, 2024
e37ae84
revise coordinator.md
ahouseholder Mar 21, 2024
b08cb96
Merge pull request #89 from CERTCC/52-page-topicsrolescoordinator-pun…
ahouseholder Mar 21, 2024
824a8bf
Revise topics/principles and docs/topics/roles/other_roles.md (#90)
ahouseholder Mar 21, 2024
ce04c8c
Revise Validation and Prioritization (#91)
ahouseholder Mar 21, 2024
a4d2f53
Move content to howto, reorder howto (#92)
ahouseholder Mar 22, 2024
c850ee6
cleaning up operations docs (#94)
ahouseholder Mar 22, 2024
05afd7d
cleaning up operations docs (#95)
ahouseholder Mar 22, 2024
3182e53
Revise iot and vul id content (#97)
ahouseholder Mar 25, 2024
9b606b7
revise docs/topics/phases/remediation.md (#98)
ahouseholder Mar 25, 2024
14bbdc3
Bump the mkdocs group with 2 updates (#96)
dependabot[bot] Mar 26, 2024
e775652
resolves #21 (#99)
ahouseholder Mar 26, 2024
f2182fb
resolves #19 (#100)
ahouseholder Mar 26, 2024
192e8dd
Revise docs/topics/phases/index.md (#101)
ahouseholder Mar 26, 2024
b1d0e78
fix broken site url (#102)
ahouseholder Mar 26, 2024
9fb26c9
Revise docs/howto/avoid_risk.md (#103)
ahouseholder Mar 26, 2024
37b4541
Revise about section (#104)
ahouseholder Mar 26, 2024
0396ed6
Revise coordinator, infrastructure, and staffing content (#105)
ahouseholder Mar 27, 2024
53cf23c
Revise howto/index.md (#106)
ahouseholder Mar 27, 2024
cc4614a
clean up reference section (#107)
ahouseholder Mar 27, 2024
9c46b63
Refactor howto section (#108)
ahouseholder Mar 28, 2024
d12f4f1
Clean up `topics` (#110)
ahouseholder Mar 28, 2024
6b5dc26
Revamp preface & terms (#113)
ahouseholder Apr 1, 2024
40c313a
Bump the mkdocs group with 2 updates (#112)
dependabot[bot] Apr 1, 2024
5993623
Bump actions/configure-pages from 4 to 5 (#111)
dependabot[bot] Apr 1, 2024
4797918
add issue template question.md (#114)
ahouseholder Apr 1, 2024
70fa471
Revamp exec summary and index (#115)
ahouseholder Apr 2, 2024
f86d9a8
clean up validation/prioritization howto (#116)
ahouseholder Apr 2, 2024
3168e90
Fix links (#117)
ahouseholder Apr 3, 2024
20603bc
Tutorials wiki (#118)
ahouseholder Apr 5, 2024
4ab40c5
clarify vendor.md (#127)
ahouseholder Apr 5, 2024
4ec1786
Special topics (#129)
ahouseholder Apr 10, 2024
82acbcb
Bump the mkdocs group with 4 updates (#128)
dependabot[bot] Apr 10, 2024
162fe81
improve navigation (#130)
ahouseholder Apr 10, 2024
6e9dee7
Add web, blockchain, vultron refs (#131)
ahouseholder Apr 10, 2024
b76fb02
Add SSVC blurb (#132)
ahouseholder Apr 10, 2024
5fdfa25
add acronyms (#133)
ahouseholder Apr 10, 2024
f3668c9
Baseline markdownlint & add action workflow (#134)
ahouseholder Apr 10, 2024
465d36e
add Linkchecker (#135)
ahouseholder Apr 10, 2024
abb5aeb
Update linkchecker.yml
ahouseholder Apr 10, 2024
fa20275
Update Readme, add Contributing.md, pr template (#136)
ahouseholder Apr 10, 2024
7e17d62
clean up old wiki exports (#137)
ahouseholder Apr 10, 2024
06d99b0
Unify nav (#138)
ahouseholder Apr 12, 2024
d69e3ca
Remove html from title (#139)
ahouseholder Apr 12, 2024
84acdb3
Update mkdocs.yml
ahouseholder Apr 12, 2024
658102b
refactor css
ahouseholder Apr 12, 2024
8f82d6d
Bump mkdocs-print-site-plugin from 2.3.6 to 2.4.0 in the mkdocs group…
dependabot[bot] Apr 15, 2024
b17136c
Bump tj-actions/changed-files from 42 to 44 (#141)
dependabot[bot] Apr 15, 2024
e9148a0
Bump DavidAnson/markdownlint-cli2-action from 15 to 16 (#140)
dependabot[bot] Apr 15, 2024
ecc9327
split trad/mobile, add unknowns
ahouseholder Apr 18, 2024
6b30867
add CODEOWNERS file
ahouseholder Apr 19, 2024
6b89748
small copyright cleanup
ahouseholder Apr 19, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# These rules follow a last-match behavior.

# default (if nothing else matches)
* @ahouseholder @ehatleback

# any markdown file in docs
/docs/**/*.md @ahouseholder @ehatleback

# website config
mkdocs.yml @ahouseholder

# github setup
/.github/ @ahouseholder @sei-vsarvepalli
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**

- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**

- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
labels: enhancement
assignees: ''

---
Expand Down
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: Question
about: Ask the CERT Guide to CVD team a question
title: Add a concise title for your question
labels: question
assignees: ''

---

*Note:* Questions for the CERT Guide to CVD team can be asked here in the form of an issue.
More general questions directed at the CERT Guide to CVD user community
might be a better fit in the [Q&A](https://github.com/CERTCC/CERT-Guide-to-CVD/discussions/categories/q-a) category of our
[Discussions](https://github.com/CERTCC/CERT-Guide-to-CVD/discussions) area.
23 changes: 23 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates

version: 2
updates:
- package-ecosystem: "pip" # See documentation for possible values
directory: "/" # Location of package manifests
schedule:
interval: "weekly"
groups:
mkdocs:
patterns:
- "mkdocs*"
update-types:
- "minor"
- "patch"
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"

1 change: 1 addition & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*Contributions to this project are subject to the terms listed in [CONTRIBUTING.md](CONTRIBUTING.md).*
62 changes: 62 additions & 0 deletions .github/workflows/deploy_site.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Simple workflow for deploying static content to GitHub Pages
name: Deploy static content to Pages

on:
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Runs on pushes targeting the default branch
push:
branches:
- publish


# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11'

- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install -r requirements.txt

- name: Setup Pages
uses: actions/configure-pages@v5

- name: Build Site
run: |
mkdocs build --verbose --clean --config-file mkdocs.yml

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload entire repository
path: 'site'

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
34 changes: 34 additions & 0 deletions .github/workflows/linkchecker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Link Checker
on:
pull_request:
paths:
- '**/*.md'
- .github/workflows/linkchecker.yml
workflow_dispatch:

jobs:
linkcheck:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.10'

- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install -r requirements.txt
python -m pip install linkchecker
# python -m pip install -e .

- name: Build Site
run: |
mkdocs build --verbose --clean --config-file mkdocs.yml

- name: Check links
run: |
linkchecker site/index.html
15 changes: 15 additions & 0 deletions .github/workflows/lint_md_all.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: "Lint Markdown (all)"

on:
workflow_dispatch:

jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: DavidAnson/markdownlint-cli2-action@v16
with:
globs: |
*.md
!test/*.md
26 changes: 26 additions & 0 deletions .github/workflows/lint_md_changes.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: "Lint Markdown (Changes)"
on:
pull_request:
paths:
- '**/*.md'
- .github/workflows/lint_md_changes.yml

jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: tj-actions/changed-files@v44
id: changed-files
with:
files: '**/*.md'
separator: ","
- uses: DavidAnson/markdownlint-cli2-action@v16
if: steps.changed-files.outputs.any_changed == 'true'
with:
globs: ${{ steps.changed-files.outputs.all_changed_files }}
separator: ","
config: .markdownlint-cli2.yaml

1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
tmp/*
29 changes: 29 additions & 0 deletions .markdownlint-cli2.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
config:
# 0004 Unordered List style
# Force dash style for unordered lists
"MDOO4":
style: "dash"
# 013 Line length
# Disabled because we have a lot of long lines. We should fix this eventually.
"MD013": false
# 033 Inline HTML
# Disabled because we use inline HTML (<br/> in table cells for example)
"MD033": false
# 041 First line in file should be a top level header
# Disabled because we use `include-markdown` plugin for merging markdown files
"MD041": false
# 046 Code block style
# Disabled because mkdocs-material uses indented blocks for admonitions
"MD046": false
# 049 emphasis style
# Force asterisk style for emphasis
"MD049":
style: "asterisk"
# 050 strong style
# Force asterisk style for strong
"MD050":
style: "asterisk"
# 051 Link fragments should be valid
# Disabled because conversion from TeX to markdown produces invalid links
# We might eventually be able to re-enable this one.
"MD051": false
109 changes: 109 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
# Contributing to the CERT Guide to CVD

Thank you for your interest in contributing to the
**CERT Guide to Coordinated Vulnerability Disclosure**
project (“We” or “Us”).
By making any Contribution to this project, you agree to the terms outlined below.

**IF YOU DO NOT AGREE TO THESE TERMS, DO NOT SUBMIT ANY CONTRIBUTION TO THIS PROJECT.**

## TERMS OF SUBMISSION (“Agreement”)

### 1. Definitions

- "**You**" means the individual who Submits a Contribution to Us.
- "**Contribution**" means any work of authorship, including but not limited to source code, object code, patch, tool,
sample, graph, specification, manual documentation, that is Submitted by You to Us in which You own or assert
ownership of the Copyright.
- "**Copyright**" means all rights protecting works of authorship owned or controlled by You, including copyright, moral
and neighboring rights, as appropriate, for the full term of their existence including any extensions by You.
- "**Material**" means the work of authorship which is made available by Us to third parties. When this Agreement covers
more than one software project, the Material means the work of authorship to which the Contribution was Submitted.
After You Submit the Contribution, it may be included in the Material.
- "**Submit**" means any form of electronic, verbal, or written communication sent to Us or our representatives, including
but not limited to electronic mailing lists, source code control systems, and issue tracking systems that are managed
by, or on behalf of, Us for the purpose of discussing and improving the Material, but excluding communication that is
conspicuously marked or otherwise designated in writing by You as "Not a Contribution."
- "**Submission Date**" means the date on which You Submit a Contribution to Us.
- "**Effective Date**" means the date You first Submit a Contribution to Us, whichever is earlier.
- "**Media**" means any portion of a Contribution which is not software.

### 2. Grant of Rights

#### 2.1 Copyright License

**(a)** You retain ownership of the Copyright in Your Contribution and have the same rights to use or license the
Contribution which You would have had without entering into the Agreement.

**(b)** To the maximum extent permitted by the relevant law, You grant to Us a perpetual, worldwide, non-exclusive,
transferable, royalty-free, irrevocable license, with the right to sublicense such rights through multiple tiers of
sublicensees, to reproduce, modify, display, perform and distribute the Contribution as part of the Material;
provided that this license is conditioned upon compliance with Section 2.2.

#### 2.2 Outbound License

Based on the grant of rights in Section 2.1, if We include Your Contribution in a Material,
We may license the Contribution under any license, including copyleft, permissive, commercial, or proprietary licenses.
As a condition on the exercise of this right, We agree to also license the Contribution under the terms of the license
or licenses which We are using for the Material on the Submission Date.

#### 2.3 Moral Rights

If moral rights apply to the Contribution, to the maximum extent permitted by law, You waive and agree not to assert
such moral rights against Us or our successors in interest, or any of our licensees, either direct or indirect.

#### 2.4 Our Rights

You acknowledge that We are not obligated to use Your Contribution as part of the Material and may decide to include any
Contribution We consider appropriate.

#### 2.5 Reservation of Rights

Any rights not expressly assigned or licensed under this section are expressly reserved by You.

### 3. General Terms

**3.1** You warrant that:

**(a)** You have the legal authority to enter into this Agreement.

**(b)** You own all rights, including but not limited to Copyright, covering the Contribution which are required to grant
the rights under Section 2. To the extent the Contribution incorporates text passages, figures, data or other
material from the works of others, You warrant that you have obtained any necessary permissions to make this
Contribution.

**(c)** The grant of rights under Section 2 does not violate any grant of rights which You have made to third parties,
including Your employer. If You are an employee, You warrant that Your employer has approved this Agreement. If You
are less than eighteen years old, Your parent or guardian must sign a printed version of this Agreement and send it
to <permission@sei.cmu.edu>.

**(d)** You shall make each Contribution in full compliance with U.S. export control laws.

**3.2** You agree to notify Us if You become aware of any circumstance that would make any of the foregoing warranties inaccurate in any respect.

**3.3** You agree to indemnify and hold Us harmless from any damage or expense that may arise in the event of a breach of
any of the warranties set forth above.

**3.4** You agree that We may publicly disclose your participation in this project and the fact that you agreed to the terms
of this Agreement.

### 4. Miscellaneous

**4.1** This Agreement will be governed by and construed in accordance with the laws of Pennsylvania excluding its
conflicts of law provisions.

**4.2** This Agreement sets out the entire agreement between You and Us for Your Contributions to Us and overrides all
other agreements or understandings.

**4.3** If You or We assign the rights or obligations received through this Agreement to a third party, as a condition of the assignment, that third party must agree in writing to abide by all the rights and obligations in the Agreement.

**4.4** The failure of either party to require performance by the other party of any provision of this Agreement in one
situation shall not affect the right of a party to require such performance at any time in the future. A waiver of
performance under a provision in one situation shall not be considered a waiver of the performance of the provision
in the future or a waiver of the provision in its entirety.

**4.5** If any provision of this Agreement is found by a court of competent jurisdiction to be void and unenforceable,
such provision will be replaced to the extent possible with a provision that comes closest to the meaning of the
original provision and which is enforceable. The terms and conditions set forth in this Agreement shall apply
notwithstanding any failure of essential purpose of this Agreement or any limited remedy to the maximum extent
possible under law.
Loading