Skip to content

Commit

Permalink
Add content for github.io site
Browse files Browse the repository at this point in the history
* add mkdocs setup

* add pdf export

* add html exports

* update requirements.txt, add dependabot config

* html to md conversion

find ../html_export -name "*.html" -exec sh -c 'pandoc "$1" -o "$(basename "$1" .html).md"' _ {} \;

* organize markdown content into folders

* organize markdown content into folders

* start renaming files

* strip out `:::` etc

* strip out `[Atlassian](https://www.atlassian.com/)`

* strip out `Document generated by Confluence on <datetime>`

* strip out extraneous heading cruft

* strip out extraneous `created by` cruft

* replace html links with md links

* add TODO to fix links

* remove non-header at top of files

* remove bottom of page links

* compress blank lines

* remove bottom of page links

* remove trailing slashes from line ends

* remove link styling

* add pages to nav

* copy look and feel from SSVC

* add intro pages to nav

* clean up overly escaped apostrophes

* add full site page

* replace overly escaped double quotes

* replace overly escaped single quotes

* add roles to nav

* remove trailing slashes from line ends

* remove link style

* remove rel nofollows

* remove rel nofollows

* remove id tags

* strip out numbers from headers

* quick hit edits

* rename files

* remove heading numbers

* add operations section

* rename files

* this document -> this documentation

* quick edits

* add grid cards

* rename files

* strip NBSPs

* add diataxis framework

* split off avoid_risk.md

* organizing docs

* organizing docs

* formatting

* formatting

* clean up

* remove recent_changes.md

* formatting

* formatting

* add cert swoosh

* rename appendices

* add recipe cards

* split recipe cards into files

* add anchors

* reorganize files to match nav

* link fixes

* cleaning up formatting

* more copy edits

* more copy edits

* more copy edits

* more copy edits

* split pgp into separate file

* add tech analysis and monitoring

* Bump the mkdocs group with 3 updates

Bumps the mkdocs group with 3 updates: [mkdocs-bibtex](https://github.com/shyamd/mkdocs-bibtex), [mkdocs-material](https://github.com/squidfunk/mkdocs-material) and [mkdocstrings](https://github.com/mkdocstrings/mkdocstrings).


Updates `mkdocs-bibtex` from 2.12.0 to 2.14.0
- [Release notes](https://github.com/shyamd/mkdocs-bibtex/releases)
- [Commits](shyamd/mkdocs-bibtex@v2.12.0...v2.14.0)

Updates `mkdocs-material` from 9.5.11 to 9.5.12
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](squidfunk/mkdocs-material@9.5.11...9.5.12)

Updates `mkdocstrings` from 0.24.0 to 0.24.1
- [Release notes](https://github.com/mkdocstrings/mkdocstrings/releases)
- [Changelog](https://github.com/mkdocstrings/mkdocstrings/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/mkdocstrings@0.24.0...0.24.1)

---
updated-dependencies:
- dependency-name: mkdocs-bibtex
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: mkdocs
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: mkdocs
- dependency-name: mkdocstrings
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: mkdocs
...

Signed-off-by: dependabot[bot] <[email protected]>

* Create main.yml

* Update main.yml

* rename deploy_site.yml

* fix a bad search/replace

* replace `---` with mdashes

* Bump the mkdocs group with 1 update

Bumps the mkdocs group with 1 update: [mkdocs-bibtex](https://github.com/shyamd/mkdocs-bibtex).


Updates `mkdocs-bibtex` from 2.14.0 to 2.14.1
- [Release notes](https://github.com/shyamd/mkdocs-bibtex/releases)
- [Commits](shyamd/mkdocs-bibtex@v2.14.0...v2.14.1)

---
updated-dependencies:
- dependency-name: mkdocs-bibtex
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: mkdocs
...

Signed-off-by: dependabot[bot] <[email protected]>

* add google analytics

* add markdown lint configuration

* markdownlint

* revise preface.md to mention AI/ML

* replace acronyms

* inline ref

* add draft docs

* add grid

* clarify nav heading

* add diagram, formatting

* Update issue templates

* update nav

* refactor TLP content

* revise sample vrf

* modify branches for auto publish

* misc formatting

* fixes #71

* Bump the mkdocs group with 2 updates

Bumps the mkdocs group with 2 updates: [mkdocs-material](https://github.com/squidfunk/mkdocs-material) and [mkdocstrings-python](https://github.com/mkdocstrings/python).


Updates `mkdocs-material` from 9.5.12 to 9.5.14
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](squidfunk/mkdocs-material@9.5.12...9.5.14)

Updates `mkdocstrings-python` from 1.8.0 to 1.9.0
- [Release notes](https://github.com/mkdocstrings/python/releases)
- [Changelog](https://github.com/mkdocstrings/python/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/python@1.8.0...1.9.0)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: mkdocs
- dependency-name: mkdocstrings-python
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: mkdocs
...

Signed-off-by: dependabot[bot] <[email protected]>

* fixes #68

* fixes #69

* fixes #70

* fixes #67

* fix section links

* add icons to grid cards

fixes #66

* replace grid with diagram

* add tips to content

resolves #64

* remove preview, integrate into tutorial intro

* add icons

* revise public awareness and publishing content

* fix references

* add tip

* add tip

* add flow chart

* convert list to tips

* split deployer process into a separate tutorial

* convert list to table

* add mkdocs header info

* split vendor process into tutorial

* refactor deployer response process doc

* add links

* add FIRST PSIRT

* revise coordinator.md

* Revise topics/principles and docs/topics/roles/other_roles.md (#90)

* resolves #55

* resolves #50

* resolves #48

* resolves #49

* resolves #46

* Revise Validation and Prioritization (#91)

* fix tip header

* split validation and triage into two files

* revise prioritization.md

* Move content to howto, reorder howto (#92)

* reorder how to

* move problem solving to howto

* fix #16

* add grid to disclosure_choices.md

* move problem solving to howto

* cleaning up operations docs (#94)

* cleaning up operations docs (#95)

* Revise iot and vul id content (#97)

* reorganize iot content

* relocate drafts

* remove reporter.md (redundant to finder.md)

* resolves #26

* revise docs/topics/phases/remediation.md (#98)

* resolves #42

* draft cleanup

* Bump the mkdocs group with 2 updates (#96)

Bumps the mkdocs group with 2 updates: [mkdocs-bibtex](https://github.com/shyamd/mkdocs-bibtex) and [mkdocs-material](https://github.com/squidfunk/mkdocs-material).


Updates `mkdocs-bibtex` from 2.14.1 to 2.14.4
- [Release notes](https://github.com/shyamd/mkdocs-bibtex/releases)
- [Commits](shyamd/mkdocs-bibtex@v2.14.1...v2.14.4)

Updates `mkdocs-material` from 9.5.14 to 9.5.15
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](squidfunk/mkdocs-material@9.5.14...9.5.15)

---
updated-dependencies:
- dependency-name: mkdocs-bibtex
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: mkdocs
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: mkdocs
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* resolves #21 (#99)

* resolves #19 (#100)

* Revise docs/topics/phases/index.md (#101)

* fix broken site url (#102)

* Revise docs/howto/avoid_risk.md (#103)

* add cross-ref for iot

* fix up references

* Revise about section (#104)

* add acks

* fix links

* update sightings.md

* resolves #7

* Revise coordinator, infrastructure, and staffing content (#105)

* resolves #9

* add bug bounty/cvd platform words to both secure_comms.md and case_tracking.md

* add deployer perspective do inventory.md

* remove obsolete infrastructure.md

* resolve #14

* Revise howto/index.md (#106)

* resolve #10

* revise maintaining_secrecy.md

* resolve #17

* resolve #18

* add vultron admonition for future

* add ssvc admonition for future

* split topology.md into a separate page

* clean up reference section (#107)

* Refactor howto section (#108)

* reorganize howto section

* reorganize howto section

* Clean up `topics` (#110)

* cleanup

* resolves #38

* resolves #39

* refactor section intros

* revamp topics section

* Revamp preface & terms (#113)

* resolve #27 (+1 squashed commit)
Squashed commits:
[a509076] rename preface.md

* refactor terms

resolves #65

* Bump the mkdocs group with 2 updates (#112)

Bumps the mkdocs group with 2 updates: [mkdocs-include-markdown-plugin](https://github.com/mondeja/mkdocs-include-markdown-plugin) and [mkdocs-material](https://github.com/squidfunk/mkdocs-material).


Updates `mkdocs-include-markdown-plugin` from 6.0.4 to 6.0.5
- [Release notes](https://github.com/mondeja/mkdocs-include-markdown-plugin/releases)
- [Commits](mondeja/mkdocs-include-markdown-plugin@v6.0.4...v6.0.5)

Updates `mkdocs-material` from 9.5.15 to 9.5.16
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](squidfunk/mkdocs-material@9.5.15...9.5.16)

---
updated-dependencies:
- dependency-name: mkdocs-include-markdown-plugin
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: mkdocs
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: mkdocs
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump actions/configure-pages from 4 to 5 (#111)

Bumps [actions/configure-pages](https://github.com/actions/configure-pages) from 4 to 5.
- [Release notes](https://github.com/actions/configure-pages/releases)
- [Commits](actions/configure-pages@v4...v5)

---
updated-dependencies:
- dependency-name: actions/configure-pages
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* add issue template question.md (#114)

* Revamp exec summary and index (#115)

* convert exec summary to nutshell with includes

* clean up index.md

* clean up validation/prioritization howto (#116)

* Fix links (#117)

* fix internal links

* fix external links

* Tutorials wiki (#118)

* add reporter tutorial

* add disclosure 101 tutorials

* update certcc guidance

* fix up some links and such

* clarify vendor.md (#127)

* Special topics (#129)

* remediation is sometimes mitigation

* generalize vul discovery.md

* convert table to admonition boxes

* refactor special topics

* Bump the mkdocs group with 4 updates (#128)

Bumps the mkdocs group with 4 updates: [mkdocs-bibtex](https://github.com/shyamd/mkdocs-bibtex), [mkdocs-material](https://github.com/squidfunk/mkdocs-material), [mkdocstrings](https://github.com/mkdocstrings/mkdocstrings) and [mkdocstrings-python](https://github.com/mkdocstrings/python).


Updates `mkdocs-bibtex` from 2.14.4 to 2.15.0
- [Release notes](https://github.com/shyamd/mkdocs-bibtex/releases)
- [Commits](shyamd/mkdocs-bibtex@v2.14.4...v2.15.0)

Updates `mkdocs-material` from 9.5.16 to 9.5.17
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](squidfunk/mkdocs-material@9.5.16...9.5.17)

Updates `mkdocstrings` from 0.24.1 to 0.24.3
- [Release notes](https://github.com/mkdocstrings/mkdocstrings/releases)
- [Changelog](https://github.com/mkdocstrings/mkdocstrings/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/mkdocstrings@0.24.1...0.24.3)

Updates `mkdocstrings-python` from 1.9.0 to 1.9.2
- [Release notes](https://github.com/mkdocstrings/python/releases)
- [Changelog](https://github.com/mkdocstrings/python/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/python@1.9.0...1.9.2)

---
updated-dependencies:
- dependency-name: mkdocs-bibtex
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: mkdocs
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: mkdocs
- dependency-name: mkdocstrings
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: mkdocs
- dependency-name: mkdocstrings-python
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: mkdocs
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* improve navigation (#130)

- enable sticky tabs
- prune nav
- integrate TOC into left nav
- allow index pages in nav

* Add web, blockchain, vultron refs (#131)

* add web, blockchain boxes

* fix #122

* fix #125

* fix #124

* Add SSVC blurb (#132)

* fix #123

* add ssvc blurbs

* add acronyms (#133)

* Baseline markdownlint & add action workflow (#134)

* markdownlint

* markdownlint

* add markdown lint actions

* add Linkchecker (#135)

* baseline link checker

* add linkchecker workflow

* only run on pr

* Update linkchecker.yml

* Update Readme, add Contributing.md, pr template (#136)

* update readme

* refactor copyright

* bring over contribution terms from vultron

* refactor community engagement, guidance etc.

* mdlint

* clean up old wiki exports (#137)

* Unify nav (#138)

* clean up

* add home link

* Remove html from title (#139)

* clean up

* add home link

* remove html from title

* Update mkdocs.yml

* refactor css

* Bump mkdocs-print-site-plugin from 2.3.6 to 2.4.0 in the mkdocs group (#142)

Bumps the mkdocs group with 1 update: [mkdocs-print-site-plugin](https://github.com/timvink/mkdocs-print-site-plugin).


Updates `mkdocs-print-site-plugin` from 2.3.6 to 2.4.0
- [Release notes](https://github.com/timvink/mkdocs-print-site-plugin/releases)
- [Commits](timvink/mkdocs-print-site-plugin@v2.3.6...v2.4.0)

---
updated-dependencies:
- dependency-name: mkdocs-print-site-plugin
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: mkdocs
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump tj-actions/changed-files from 42 to 44 (#141)

Bumps [tj-actions/changed-files](https://github.com/tj-actions/changed-files) from 42 to 44.
- [Release notes](https://github.com/tj-actions/changed-files/releases)
- [Changelog](https://github.com/tj-actions/changed-files/blob/main/HISTORY.md)
- [Commits](tj-actions/changed-files@v42...v44)

---
updated-dependencies:
- dependency-name: tj-actions/changed-files
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump DavidAnson/markdownlint-cli2-action from 15 to 16 (#140)

Bumps [DavidAnson/markdownlint-cli2-action](https://github.com/davidanson/markdownlint-cli2-action) from 15 to 16.
- [Release notes](https://github.com/davidanson/markdownlint-cli2-action/releases)
- [Commits](DavidAnson/markdownlint-cli2-action@v15...v16)

---
updated-dependencies:
- dependency-name: DavidAnson/markdownlint-cli2-action
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* split trad/mobile, add unknowns

* add CODEOWNERS file

* small copyright cleanup

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
  • Loading branch information
ahouseholder and dependabot[bot] authored Apr 19, 2024
1 parent c56d1e3 commit 770f7a0
Show file tree
Hide file tree
Showing 173 changed files with 11,072 additions and 4 deletions.
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 <[email protected]>.

**(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

0 comments on commit 770f7a0

Please sign in to comment.