Add updated copyright templates to this project.

center-for-threat-informed-defense · Mar 15, 2024 · 649a1fc · 649a1fc
1 parent 6da077b
commit 649a1fc
Show file tree

Hide file tree

Showing 4 changed files with 84 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -30,10 +30,10 @@ Set the extension's TOC:Levels setting to "2..6"
 
 To get started, read the project website. It provides an overview of the goals and methodologies and includes details on how and why to use this methodology.
 
-| Resource                                                                                       | Description                                                   |
-| ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
+| Resource                                                                       | Description                                   |
+| ------------------------------------------------------------------------------ | --------------------------------------------- |
 | [Project Website](https://center-for-threat-informed-defense.github.io/m3tid/) | Complete documentation for the M3TID project. |
-| [Scoring Spreadsheet](docs/M3TIDScoringSpreadsheet.xlsx)                          | A spreadsheet for self-evaluation.        |
+| [Scoring Spreadsheet](docs/M3TIDScoringSpreadsheet.xlsx)                       | A spreadsheet for self-evaluation.            |
 
 
 ## Getting Involved
@@ -77,9 +77,8 @@ directly for more general inquiries.
 
 ## Notice
 
-<!-- TODO Add PRS prior to publication. -->
-
-Copyright 2024 MITRE Engenuity. Approved for public release. Document number REPLACE_WITH_PRS_NUMBER
+Copyright 2024 MITRE Engenuity. Approved for public release. Document number(s)
+REPLACE_WITH_PRS_NUMBER.
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this
 file except in compliance with the License. You may obtain a copy of the License at

diff --git a/docs/_templates/footer.html b/docs/_templates/footer.html
@@ -0,0 +1,65 @@
+<footer>
+    {%- if (theme_prev_next_buttons_location == 'bottom' or theme_prev_next_buttons_location == 'both') and (next or
+    prev) %}
+    {#- Translators: This is an ARIA section label for the footer section of the page. -#}
+    <div class="rst-footer-buttons" role="navigation" aria-label="{{ _('Footer') }}">
+        {%- if prev %}
+        <a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}"
+            accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> {{ _('Previous')
+            }}</a>
+        {%- endif %}
+        {%- if next %}
+        <a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}"
+            accesskey="n" rel="next">{{ _('Next') }} <span class="fa fa-arrow-circle-right"
+                aria-hidden="true"></span></a>
+        {%- endif %}
+    </div>
+    {%- endif %}
+
+    <hr />
+
+    <div role="contentinfo">
+        {%- block contentinfo %}
+        <p>
+            {%- if show_copyright %}
+            &#169; {{ copyright_years }} MITRE Engenuity. Approved for public release.
+            Document number(s) {{ prs_numbers }}.
+            {%- endif %}
+
+            {%- if build_id and build_url %}
+            <span class="build">
+                {#- Translators: Build is a noun, not a verb -#}
+                {%- trans %}Build{% endtrans -%}
+                <a href="{{ build_url }}">{{ build_id }}</a>.
+            </span>
+            {%- elif commit %}
+            <span class="commit">
+                {#- Translators: the phrase "revision" comes from Git, referring to a commit #}
+                {%- trans %}Revision{% endtrans %} <code>{{ commit }}</code>.
+            </span>
+            {%- endif %}
+            {%- if last_updated %}
+            <span class="lastupdated">
+                {%- trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
+            </span>
+            {%- endif -%}
+
+        </p>
+        {%- endblock %}
+    </div>
+
+    {% if show_sphinx %}
+    {%- set sphinx_web = '<a href="https://www.sphinx-doc.org/">Sphinx</a>' %}
+    {%- set readthedocs_web = '<a href="https://readthedocs.org">Read the Docs</a>' %}
+    {#- Translators: the variable "sphinx_web" is a link to the Sphinx project documentation with the text "Sphinx" #}
+    {%- trans sphinx_web=sphinx_web, readthedocs_web=readthedocs_web %}Built with {{ sphinx_web }} using a{% endtrans %}
+    {#- Translators: "theme" refers to a theme for Sphinx, which alters the appearance of the generated documentation #}
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">{% trans %}theme{% endtrans %}</a>
+    {#- Translators: this is always used as "provided by Read the Docs", and should not imply Read the Docs is an author
+    of the generated documentation. #}
+    {% trans %}provided by {{ readthedocs_web }}{% endtrans %}.
+    {% endif %}
+
+    {%- block extrafooter %} {% endblock %}
+
+</footer>
diff --git a/docs/conf.py b/docs/conf.py
@@ -18,8 +18,9 @@
 # -- Project information -----------------------------------------------------
 
 project = "M3TID"
-copyright = "2024, Center for Threat-Informed Defense"
 author = "Center for Threat-Informed Defense"
+copyright_years = "2024"
+prs_numbers = "REPLACE_WITH_PRS_NUMBER"
 
 # The full version, including alpha/beta/rc tags
 version = "v1.0.0"
@@ -43,6 +44,10 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
+rst_prolog = f"""
+.. |copyright_years| replace:: {copyright_years}
+.. |prs_numbers| replace:: {prs_numbers}
+"""
 
 # -- Options for HTML output -------------------------------------------------
 
@@ -61,7 +66,10 @@
 html_show_sourcelink = False
 html_show_sphinx = False
 html_use_smartypants = False
-
+html_context = {
+    "copyright_years": copyright_years,
+    "prs_numbers": prs_numbers,
+}
 html_theme_options = {
     "analytics_id": "G-VX41LMPC2R",
     "display_version": True,

diff --git a/docs/index.rst b/docs/index.rst
@@ -4,7 +4,7 @@ M3TID |version|
 Background
 -----------
 
-Globally, security practitioners, security program leaders, and Board members seek to answer the question “How secure are we?” Our research adds a complementary approach to answering that question, to be combined with traditional cybersecurity best practices and maturity models. This is a starting point for building an effective Threat-Informed Defense that enables a data-driven approach to optimizing investments. 
+Globally, security practitioners, security program leaders, and Board members seek to answer the question “How secure are we?” Our research adds a complementary approach to answering that question, to be combined with traditional cybersecurity best practices and maturity models. This is a starting point for building an effective Threat-Informed Defense that enables a data-driven approach to optimizing investments.
 
 The Center for Threat-Informed Defense (the Center) contends that one of the most impactful ways to manage a security program is to leverage knowledge of cyber threats to prioritize the allocation of limited resources to reduce overall risk. As risk is the product of probability and impact, it is crucially important to have a thorough knowledge of actual threat actors, their capabilities, and their typical tactics, techniques, and procedures (TTPs). By understanding the adversary well, an organization can prioritize their defenses as well as pre-emptively and continuously assess themselves to identify gaps. This enables organizations to shift to a more proactive approach to security, constantly learning, assessing, and improving their security programs. The goal of this shift is to increase the cost and difficulty for the adversaries thereby increasing security. Forcing adversaries to create new tooling, find new vulnerabilities and exploits, and attempt to discover new paths into an organization’s environment drives their cost in manpower, infrastructure, and time. It also forces them to restart their attack lifecycle, creating additional opportunities for detection and response. The ultimate goal is to create a situation such that attacking is so costly and/or so difficult that it is no longer reasonable for the adversary to attack.
 
@@ -14,7 +14,7 @@ The M3TID Project
 
 The Measure, Maximize, Mature Threat-Informed Defense (M3TID) project extends this concept of leveraging Threat understanding to improve a security program by working towards an actionable definition of Threat-Informed Defense (TID) and its associated key activities. The M3TID project is based on the hypothesis that applying Threat-Informed Defense will improve the efficiency of a security program and reduce organizational risk. The project captures insights and best practices for what it means to be threat-informed across a security program, expanding the dimensions of Threat-Informed Defense into key components that organizations should implement. For each of these components, the M3TID project defines discrete levels reflecting implementations of that component from least-to-most threat-informed.
 
-The intent of the M3TID project is that organizations, from security practitioners to executive leaders, will be able to leverage this measurement framework to better assess and understand their current position in terms of a Threat-Informed Defense security program. With this first framework for measuring the degree to which threat information is guiding security practices, the Center can start to gather the data needed to refine the model to reflect the relative importance of each of these components in contributing to bottom-line cyber risk reduction. 
+The intent of the M3TID project is that organizations, from security practitioners to executive leaders, will be able to leverage this measurement framework to better assess and understand their current position in terms of a Threat-Informed Defense security program. With this first framework for measuring the degree to which threat information is guiding security practices, the Center can start to gather the data needed to refine the model to reflect the relative importance of each of these components in contributing to bottom-line cyber risk reduction.
 
 
 .. toctree::
@@ -36,8 +36,8 @@ The intent of the M3TID project is that organizations, from security practitione
 Notice
 ------
 
-© 2024 MITRE Engenuity. Approved for public release. Document number
-REPLACE_WITH_PRS_NUMBER.
+© |copyright_years| MITRE Engenuity. Approved for public release. Document number(s)
+|prs_numbers|.
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this
 file except in compliance with the License. You may obtain a copy of the License at