Add design documentation

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1 @@
+Please note: Pull request submissions are subject to our [Contribution Instructions](https://github.com/CERTCC/Vultron/blob/main/ContributionInstructions.md).

.github/workflows/deploy_site.yml

@@ -0,0 +1,60 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: [main, feature/*]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# 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@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -r requirements.txt
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+
+      - name: Build Site
+        run: |
+          mkdocs build --verbose --clean --config-file mkdocs.yml       
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          # Upload entire repository
+          path: 'site'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.gitignore

@@ -128,3 +128,4 @@ dmypy.json
 # Pyre type checker
 .pyre/
 /tmp/
+/TODO.md

Acknowledgements.md

@@ -11,28 +11,28 @@ Department of Defense.
 ### The CERT Guide to Coordinated Vulnerability Disclosure
 
 - Allen D. Householder, Garret Wassermann, Art Manion, Christopher King
-- Original 2017 publication: https://doi.org/10.1184/R1/12367340.v1
-- 2019 Update: https://vuls.cert.org/confluence/display/CVD
+- Original 2017 publication: <https://doi.org/10.1184/R1/12367340.v1>
+- 2019 Update: <https://vuls.cert.org/confluence/display/CVD>
 
 ### A State-Based Model for Multi-Party Coordinated Vulnerability Disclosure (MPCVD)
 
 - Allen D. Householder and Jonathan Spring
-- https://doi.org/10.1184/R1/16416771
+- <https://doi.org/10.1184/R1/16416771>
 
 ### Are We Skillful or Just Lucky? Interpreting the Possible Histories of Vulnerability Disclosures
 
 - Allen D. Householder and Jonathan Spring
-- https://doi.org/10.1145/3477431
+- <https://doi.org/10.1145/3477431>
 
 ### Designing Vultron: A Protocol for Multi-Party Coordinated Vulnerability Disclosure (MPCVD)
 
 - Allen D. Householder
-- https://doi.org/10.1184/R1/19852798
+- <https://doi.org/10.1184/R1/19852798>
 
 ### Coordinated Vulnerability Disclosure User Stories
 
 - Brad Runyon, Eric Hatleback, Allen D. Householder, Art Manion, Vijay S. Sarvepalli, Timur D. Snoke, Jonathan Spring,
   Laurie Tyzenhaus, Charles G. Yarbrough
-- https://resources.sei.cmu.edu/library/asset-view.cfm?assetid=886543
+- <https://resources.sei.cmu.edu/library/asset-view.cfm?assetid=886543>
 
 DM23-0698

CONTRIBUTING.md

@@ -2,7 +2,8 @@
 
 Thank you for your interest in contributing to Vultron!
 
-Please review [ContributionInstructions.md](ContributionInstructions.md) before submitting any Pull Requests.
+Please review our [Contribution Instructions](https://github.com/CERTCC/Vultron/blob/main/ContributionInstructions.md)
+before submitting any Pull Requests.
 
 <!--
 ## Code of Conduct
@@ -16,7 +17,7 @@ There are a number of ways you can contribute to the development of Vultron.
 
 ### Participate in Discussions
 
-- Participate in an existing [Discussions](https://github.com/CERTCC/Vultron/discussions) or start a new one.
+- Participate in an existing [Discussion](https://github.com/CERTCC/Vultron/discussions) or start a new one.
 
 ### Report Bugs
 

ContributionInstructions.md

@@ -39,7 +39,7 @@ provided that this license is conditioned upon compliance with Section 2.2.
 
 ### 2.2 Outbound License
 
-Based on the grant of rights in [Sections 2.1](#2.1-copyright-license), if We include Your Contribution in a Material, 
+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.

VERSION

@@ -0,0 +1 @@
+0.5.0

doc/README.md

@@ -1,6 +1,6 @@
 # Vultron Docs
 
 What's here:
-- [User Stories](/doc/user_stories/)
+- [User Stories](/docs/topics/user_stories/)
 - [Activity Vocabulary Examples](/doc/examples/)
 

docs/about/acknowledgements.md

@@ -0,0 +1 @@
+{% include-markdown "../../Acknowledgements.md" %}

docs/about/contributing.md

@@ -0,0 +1,5 @@
+{% include-markdown "../../CONTRIBUTING.md" %}
+
+## Contribution Instructions
+
+{% include-markdown "../../ContributionInstructions.md" heading-offset=2 %}

FAQ.md → docs/about/faq.md

@@ -1,6 +1,6 @@
-# Vultron Frequently Asked Questions
+# Vultron Protocol Frequently Asked Questions
 
-## What do we need to move Vultron to widespread use?
+## What do we need to move the Vultron Protocol to widespread use?
 
 First, we need to finish the protocol and get it to a sufficiently stable state that we can start to use it even in 
 test environments.  We're not there yet.
@@ -11,13 +11,13 @@ In the meantime, there are a number of other things that can help. We're looking
 ## How do we apply encryption to ActivityPub messages to enable end-to-end encryption?
 
 We're of the opinion that encrypted messaging is a feature that should be available to all users of
-ActivityPub, not just those using Vultron to coordinate vulnerability cases.
+ActivityPub, not just those using the Vultron Protocol to coordinate vulnerability cases.
 Therefore, our position is that end-to-end encryption would be better implemented as a layer on top of the ActivityPub
 protocol, rather
-than as a specific feature of the Vultron protocol.
+than as a specific feature of the Vultron Protocol.
 From what we can tell, the topic has come up before in the ActivityPub community, but there is no
 standardized solution yet.
-We're currently focused on developing the Vultron protocol, but we realize that encryption may be a requirement for
+We're currently focused on developing the Vultron Protocol, but we realize that encryption may be a requirement for
 widespread adoption, so we're keeping an eye on the topic.
 
 Some relevant links include:
@@ -42,7 +42,7 @@ Some relevant links include:
 We are interested in any developments in this space, please let us know if you are aware of more recent developments.
 We'd be interested to know how we could help with efforts to bring encrypted messaging to ActivityPub.
 
-## What are the requirements for the participants?
+## What are the requirements for contributing?
 
-See [CONTRIBUTING.md](CONTRIBUTING.MD)
+See [CONTRIBUTING](contributing.md)
 

docs/about/license.md

@@ -0,0 +1 @@
+{% include-markdown "../../LICENSE.md" %}