diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml index 09e4232..ca60b30 100644 --- a/.github/workflows/sphinx.yml +++ b/.github/workflows/sphinx.yml @@ -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 @@ -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 diff --git a/README.md b/README.md index 9f41556..8123c47 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/index.rst b/docs/index.rst index 713a891..649ff34 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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) `_ and is funded by our `research -participants `_, 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) +`_ +and is funded by our `research participants `_, 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 `_ project by allowing defenders to use both resources to understand their overall defensive coverage and make threat-informed decisions. diff --git a/docs/levels/index.rst b/docs/levels/index.rst index e1b351e..736b5ea 100644 --- a/docs/levels/index.rst +++ b/docs/levels/index.rst @@ -12,7 +12,7 @@ View Mappings .. raw:: html

- + Download Mappings – Excel

diff --git a/mappings/input/enterprise/xlsx/Sensor to Data Source.xlsx b/mappings/input/enterprise/xlsx/Sensor to Data Source.xlsx deleted file mode 100644 index 826e029..0000000 Binary files a/mappings/input/enterprise/xlsx/Sensor to Data Source.xlsx and /dev/null differ