Skip to content

Commit

Permalink
Getting ready for publication
Browse files Browse the repository at this point in the history
- Fix link to website
- Remove duplicate spreadsheet and update links
- Uncomment github pages build
  • Loading branch information
mehaase committed Dec 12, 2023
1 parent 42dc24e commit add1aa8
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 36 deletions.
49 changes: 24 additions & 25 deletions .github/workflows/sphinx.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
- name: Build HTML docs
run: poetry run make docs-ci
- name: Copy Mappings Excel to Website
run: mkdir docs/extra/xlsx && cp "mappings/input/enterprise/xlsx/Sensor to Data Source.xlsx" docs/extra/xlsx
run: mkdir docs/extra/xlsx && cp "mappings/input/enterprise/xlsx/Sensor ID to Data Source.xlsx" docs/extra/xlsx
- name: Copy Mappings CSVs to Website
run: mkdir docs/extra/csv && cp mappings/input/enterprise/csv/*.csv docs/extra/csv
- name: Copy Navigator Layers to Website
Expand All @@ -43,28 +43,27 @@ jobs:
name: sensor-mappings-to-attack-docs-html
path: docs/_build/dirhtml/

# # TODO Uncomment before publishing repository.
# github_pages:
# # This job only runs when committing or merging to main branch.
# if: github.ref_name == 'main'
# needs: docs
# runs-on: ubuntu-latest
# environment:
# name: github-pages
# url: $\{\{ steps.deployment.outputs.page_url \}\}
github_pages:
# This job only runs when committing or merging to main branch.
if: github.ref_name == 'main'
needs: docs
runs-on: ubuntu-latest
environment:
name: github-pages
url: $\{\{ steps.deployment.outputs.page_url \}\}

# steps:
# - name: Setup Pages
# uses: actions/configure-pages@v2
# - name: Download HTML docs
# uses: actions/download-artifact@v3
# with:
# name: sensor-mappings-to-attack-docs-html
# path: docs
# - name: Upload artifact
# uses: actions/upload-pages-artifact@v1
# with:
# path: ./docs
# - name: Deploy to GitHub Pages
# id: deployment
# uses: actions/deploy-pages@v1
steps:
- name: Setup Pages
uses: actions/configure-pages@v2
- name: Download HTML docs
uses: actions/download-artifact@v3
with:
name: sensor-mappings-to-attack-docs-html
path: docs
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: ./docs
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ the Center's [Security Stack Mappings](https://github.com/center-for-threat-info
To get started, read the project website. It provides an overview of the goals and
methodologies, defines all the key terms, and contains detailed examples.

| Resource | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ |
| [Project Website](https://center-for-threat-informed-defense.github.io/sensor-mappings-to-attack/) | Documentation, methodology, use cases, examples. |
| [Mappings Spreadsheet](https://github.com/center-for-threat-informed-defense/sensor-mappings-to-attack/blob/main/mappings/input/enterprise/xlsx/Sensor%20to%20Data%20Source.xlsx) | Complete list of Sensor Mappings. |
| [Navigator Layers](https://github.com/center-for-threat-informed-defense/sensor-mappings-to-attack/tree/main/mappings/layers/enterprise) | ATT&CK Navigator views of the Sensor Mappings. |
| [STIX Bundles](https://github.com/center-for-threat-informed-defense/sensor-mappings-to-attack/tree/main/mappings/stix/enterprise) | Machine-readable list of Sensor Mappings. |
| Resource | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ |
| [Project Website](https://center-for-threat-informed-defense.github.io/sensor-mappings-to-attack/) | Documentation, methodology, use cases, examples. |
| [Mappings Spreadsheet](https://github.com/center-for-threat-informed-defense/sensor-mappings-to-attack/blob/main/mappings/input/enterprise/xlsx/Sensor%20ID%20to%20Data%20Source.xlsx) | Complete list of Sensor Mappings. |
| [Navigator Layers](https://github.com/center-for-threat-informed-defense/sensor-mappings-to-attack/tree/main/mappings/layers/enterprise) | ATT&CK Navigator views of the Sensor Mappings. |
| [STIX Bundles](https://github.com/center-for-threat-informed-defense/sensor-mappings-to-attack/tree/main/mappings/stix/enterprise) | Machine-readable list of Sensor Mappings. |

## Getting Involved

Expand Down
9 changes: 5 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,11 @@ representions of information that can be collected to concrete logs, sensors, an
security capabilities that provide that type of data.

This project is created and maintained by `MITRE Engenuity Center for Threat-Informed
Defense (Center) <https://ctid.mitre-engenuity.org/>`_ and is funded by our `research
participants <https://TODO>`_, in futherance of our mission to advance the start of the
art and the state of the practice in threat-informed defense globally. This work
complements the Center's `Security Stack Mappings
Defense (Center)
<https://mitre-engenuity.org/cybersecurity/center-for-threat-informed-defense/our-work/sensor-mappings-to-attack/#research-participants>`_
and is funded by our `research participants <https://TODO>`_, in futherance of our
mission to advance the start of the art and the state of the practice in threat-informed
defense globally. This work complements the Center's `Security Stack Mappings
<https://github.com/center-for-threat-informed-defense/security-stack-mappings>`_
project by allowing defenders to use both resources to understand their overall
defensive coverage and make threat-informed decisions.
Expand Down
2 changes: 1 addition & 1 deletion docs/levels/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ View Mappings
.. raw:: html

<p>
<a class="btn btn-primary" target="_blank" href="../xlsx/Sensor%20to%20Data%20Source.xlsx">
<a class="btn btn-primary" target="_blank" href="../xlsx/Sensor%20ID%20to%20Data%20Source.xlsx">
<i class="fa fa-file-excel-o"></i> Download Mappings – Excel</a>
</p>

Expand Down
Binary file not shown.

0 comments on commit add1aa8

Please sign in to comment.