diff --git a/.gitignore b/.gitignore index 0a10a7384..b9632b27f 100644 --- a/.gitignore +++ b/.gitignore @@ -6,4 +6,4 @@ npm-debug.log *.csv graph.json .DS_Store -.idea \ No newline at end of file +.idea diff --git a/docs/_build/html/_static/css/custom.css b/docs/_build/html/_static/css/custom.css new file mode 100644 index 000000000..e996d6e2b --- /dev/null +++ b/docs/_build/html/_static/css/custom.css @@ -0,0 +1,11 @@ +/* Custom style for 'deprecated' admonitions */ +div.admonition.deprecated { + border-left: 4px solid #e03e2d; /* Strong red border */ + background-color: #ffeaea; /* Light red background */ +} + +/* Title bar styling */ +div.admonition.deprecated .admonition-title { + background-color: #e03e2d; + color: white; +} diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css new file mode 100644 index 000000000..e996d6e2b --- /dev/null +++ b/docs/_static/css/custom.css @@ -0,0 +1,11 @@ +/* Custom style for 'deprecated' admonitions */ +div.admonition.deprecated { + border-left: 4px solid #e03e2d; /* Strong red border */ + background-color: #ffeaea; /* Light red background */ +} + +/* Title bar styling */ +div.admonition.deprecated .admonition-title { + background-color: #e03e2d; + color: white; +} diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html new file mode 100644 index 000000000..bb47850e1 --- /dev/null +++ b/docs/_templates/layout.html @@ -0,0 +1,8 @@ +{% extends "!layout.html" %} + +{% block extrahead %} + {{ super() }} + {% if meta is defined and meta.canonical %} + + {% endif %} +{% endblock %} diff --git a/docs/conf.py b/docs/conf.py index bac7f2cff..417be1b12 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -33,6 +33,7 @@ import sphinx_rtd_theme extensions = [ "sphinx_rtd_theme", + "sphinx.ext.todo", ] # Add any paths that contain templates here, relative to this directory. @@ -51,6 +52,19 @@ # html_theme = 'sphinx_rtd_theme' +# Canonical URL for SEO +html_context = { + "canonical_url": "https://bloodhound.specterops.io/" +} + +# Static files path +html_static_path = ['_static'] + +# Load custom CSS so that deprecated notice boxes are displayed in red +def setup(app): + app.add_css_file('css/custom.css') # relative to _static/ + + # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". diff --git a/docs/css/custom.css b/docs/css/custom.css new file mode 100644 index 000000000..e996d6e2b --- /dev/null +++ b/docs/css/custom.css @@ -0,0 +1,11 @@ +/* Custom style for 'deprecated' admonitions */ +div.admonition.deprecated { + border-left: 4px solid #e03e2d; /* Strong red border */ + background-color: #ffeaea; /* Light red background */ +} + +/* Title bar styling */ +div.admonition.deprecated .admonition-title { + background-color: #e03e2d; + color: white; +} diff --git a/docs/data-analysis/bloodhound-gui.rst b/docs/data-analysis/bloodhound-gui.rst index bef1295fd..04738c059 100644 --- a/docs/data-analysis/bloodhound-gui.rst +++ b/docs/data-analysis/bloodhound-gui.rst @@ -1,9 +1,12 @@ -.. note:: - This documentation applies to Legacy BloodHound and is no longer maintained. +.. admonition:: Deprecated Documentation + :class: deprecated - See up-to-date documentation for BloodHound CE here: `BloodHound Support`_ + **This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).** -.. _BloodHound Support: https://support.bloodhoundenterprise.io/hc/en-us + Please use the `current BloodHound CE Documentation `_. + +.. meta:: + :canonical: https://bloodhound.specterops.io/analyze-data/bloodhound-gui/cypher-search The BloodHound GUI ================== diff --git a/docs/data-analysis/edges.rst b/docs/data-analysis/edges.rst index 1df70fb92..dc73ba7e3 100644 --- a/docs/data-analysis/edges.rst +++ b/docs/data-analysis/edges.rst @@ -1,9 +1,12 @@ -.. note:: - This documentation applies to Legacy BloodHound and is no longer maintained. +.. admonition:: Deprecated Documentation + :class: deprecated - See up-to-date documentation for BloodHound CE here: `About BloodHound Edges`_ + **This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).** -.. _About BloodHound Edges: https://support.bloodhoundenterprise.io/hc/en-us/articles/17224136169371 + Please use the `current BloodHound CE Documentation `_. + +.. meta:: + :canonical: https://bloodhound.specterops.io/resources/edges/overview Edges ===== diff --git a/docs/data-analysis/nodes.rst b/docs/data-analysis/nodes.rst index 8c06e1e85..479cf187f 100644 --- a/docs/data-analysis/nodes.rst +++ b/docs/data-analysis/nodes.rst @@ -1,9 +1,12 @@ -.. note:: - This documentation applies to Legacy BloodHound and is no longer maintained. +.. admonition:: Deprecated Documentation + :class: deprecated - See up-to-date documentation for BloodHound CE here: `About BloodHound Nodes`_ + **This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).** -.. _About BloodHound Nodes: https://support.bloodhoundenterprise.io/hc/en-us/articles/17605671475867 + Please use the `current BloodHound CE Documentation `_. + +.. meta:: + :canonical: https://bloodhound.specterops.io/resources/nodes/overview Nodes ===== diff --git a/docs/data-collection/azurehound-all-flags.rst b/docs/data-collection/azurehound-all-flags.rst index fb73df367..b78405df1 100644 --- a/docs/data-collection/azurehound-all-flags.rst +++ b/docs/data-collection/azurehound-all-flags.rst @@ -1,9 +1,12 @@ -.. note:: - This documentation applies to Legacy BloodHound and is no longer maintained. +.. admonition:: Deprecated Documentation + :class: deprecated - See up-to-date documentation for BloodHound CE here: `All AzureHound Community Edition Flags, Explained`_ + **This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).** -.. _All AzureHound Community Edition Flags, Explained: https://support.bloodhoundenterprise.io/hc/en-us/articles/17481642843803 + Please use the `current BloodHound CE Documentation `_. + +.. meta:: + :canonical: https://bloodhound.specterops.io/collect-data/ce-collection/azurehound-flags All AzureHound Flags, Explained =============================== diff --git a/docs/data-collection/azurehound.rst b/docs/data-collection/azurehound.rst index a86bbeccf..be8431141 100644 --- a/docs/data-collection/azurehound.rst +++ b/docs/data-collection/azurehound.rst @@ -1,9 +1,12 @@ -.. note:: - This documentation applies to Legacy BloodHound and is no longer maintained. +.. admonition:: Deprecated Documentation + :class: deprecated - See up-to-date documentation for BloodHound CE here: `AzureHound Community Edition`_ + **This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).** -.. _AzureHound Community Edition: https://support.bloodhoundenterprise.io/hc/en-us/articles/17481394564251 + Please use the `current BloodHound CE Documentation `_. + +.. meta:: + :canonical: https://bloodhound.specterops.io/collect-data/ce-collection/azurehound AzureHound ========== diff --git a/docs/data-collection/bloodhound-py.rst b/docs/data-collection/bloodhound-py.rst index cb4343255..aa47a308b 100644 --- a/docs/data-collection/bloodhound-py.rst +++ b/docs/data-collection/bloodhound-py.rst @@ -1,9 +1,12 @@ -.. note:: - This documentation applies to Legacy BloodHound and is no longer maintained. +.. admonition:: Deprecated Documentation + :class: deprecated - See up-to-date documentation for BloodHound.py here: `BloodHound.py`_ + **This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).** -.. _BloodHound.py: https://github.com/dirkjanm/BloodHound.py + Please use the `current BloodHound CE Documentation `_. + +.. meta:: + :canonical: https://bloodhound.specterops.io/get-started/introduction BloodHound.py diff --git a/docs/data-collection/sharphound-all-flags.rst b/docs/data-collection/sharphound-all-flags.rst index 778959b63..3fb5df1c8 100644 --- a/docs/data-collection/sharphound-all-flags.rst +++ b/docs/data-collection/sharphound-all-flags.rst @@ -1,9 +1,12 @@ -.. note:: - This documentation applies to Legacy BloodHound and is no longer maintained. +.. admonition:: Deprecated Documentation + :class: deprecated - See up-to-date documentation for BloodHound CE here: `All SharpHound Community Edition Flags, Explained`_ + **This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).** -.. _All SharpHound Community Edition Flags, Explained: https://support.bloodhoundenterprise.io/hc/en-us/articles/17481375424795 + Please use the `current BloodHound CE Documentation `_. + +.. meta:: + :canonical: https://bloodhound.specterops.io/collect-data/ce-collection/sharphound-flags All SharpHound Flags, Explained =============================== diff --git a/docs/data-collection/sharphound.rst b/docs/data-collection/sharphound.rst index 81fd5fcdc..37f8f8d43 100644 --- a/docs/data-collection/sharphound.rst +++ b/docs/data-collection/sharphound.rst @@ -1,9 +1,13 @@ -.. note:: - This documentation applies to Legacy BloodHound and is no longer maintained. +.. admonition:: Deprecated Documentation + :class: deprecated - See up-to-date documentation for BloodHound CE here: `SharpHound CE`_ + **This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).** + + Please use the `current BloodHound CE Documentation `_. + +.. meta:: + :canonical: https://bloodhound.specterops.io/collect-data/ce-collection/sharphound -.. _SharpHound CE: https://support.bloodhoundenterprise.io/hc/en-us/articles/17481151861019 SharpHound ========== diff --git a/docs/further-reading/further-reading.rst b/docs/further-reading/further-reading.rst index 3346eaf3a..3500462cc 100644 --- a/docs/further-reading/further-reading.rst +++ b/docs/further-reading/further-reading.rst @@ -1,9 +1,12 @@ -.. note:: - This documentation applies to Legacy BloodHound and is no longer maintained. +.. admonition:: Deprecated Documentation + :class: deprecated - See up-to-date documentation for BloodHound CE here: `BloodHound Support`_ + **This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).** -.. _BloodHound Support: https://support.bloodhoundenterprise.io/hc/en-us + Please use the `current BloodHound CE Documentation `_. + +.. meta:: + :canonical: https://bloodhound.specterops.io/collect-data/ce-collection/overview Further Reading/Viewing ======================= diff --git a/docs/further-reading/json.rst b/docs/further-reading/json.rst index 694073d60..52f04fed4 100644 --- a/docs/further-reading/json.rst +++ b/docs/further-reading/json.rst @@ -1,9 +1,12 @@ -.. note:: - This documentation applies to Legacy BloodHound and is no longer maintained. +.. admonition:: Deprecated Documentation + :class: deprecated - See up-to-date documentation for BloodHound CE here: `BloodHound Support`_ + **This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).** -.. _BloodHound Support: https://support.bloodhoundenterprise.io/hc/en-us + Please use the `current BloodHound CE Documentation `_. + +.. meta:: + :canonical: https://bloodhound.specterops.io/integrations/bloodhound-api/working-with-api BloodHound JSON Formats ======================= diff --git a/docs/index.rst b/docs/index.rst index affc011d2..5d49be890 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,9 +1,13 @@ -.. note:: - This documentation applies to Legacy BloodHound and is no longer maintained. +.. admonition:: Deprecated Documentation + :class: deprecated - See up-to-date documentation for BloodHound CE here: `BloodHound Support`_ + **This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).** + + Please use the `current BloodHound CE Documentation `_. + +.. meta:: + :canonical: https://bloodhound.specterops.io/ -.. _BloodHound Support: https://support.bloodhoundenterprise.io/hc/en-us BloodHound: Six Degrees of Domain Admin ======================================= diff --git a/docs/installation/linux.rst b/docs/installation/linux.rst index afc7c38d7..d5198ec21 100644 --- a/docs/installation/linux.rst +++ b/docs/installation/linux.rst @@ -1,9 +1,12 @@ -.. note:: - This documentation applies to Legacy BloodHound and is no longer maintained. +.. admonition:: Deprecated Documentation + :class: deprecated - See up-to-date documentation for BloodHound CE here: `Install BloodHound Community Edition with Docker Compose`_ + **This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).** -.. _Install BloodHound Community Edition with Docker Compose: https://support.bloodhoundenterprise.io/hc/en-us/articles/17468450058267 + Please use the `current BloodHound CE Documentation `_. + +.. meta:: + :canonical: https://bloodhound.specterops.io/get-started/quickstart/community-edition-quickstart Linux ===== diff --git a/docs/installation/osx.rst b/docs/installation/osx.rst index 2cd4a8f99..b7f49cd1e 100644 --- a/docs/installation/osx.rst +++ b/docs/installation/osx.rst @@ -1,9 +1,12 @@ -.. note:: - This documentation applies to Legacy BloodHound and is no longer maintained. +.. admonition:: Deprecated Documentation + :class: deprecated - See up-to-date documentation for BloodHound CE here: `Install BloodHound Community Edition with Docker Compose`_ + **This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).** -.. _Install BloodHound Community Edition with Docker Compose: https://support.bloodhoundenterprise.io/hc/en-us/articles/17468450058267 + Please use the `current BloodHound CE Documentation `_. + +.. meta:: + :canonical: https://bloodhound.specterops.io/get-started/quickstart/community-edition-quickstart macOS ===== diff --git a/docs/installation/windows.rst b/docs/installation/windows.rst index 6f10bf095..824951f33 100644 --- a/docs/installation/windows.rst +++ b/docs/installation/windows.rst @@ -1,9 +1,12 @@ -.. note:: - This documentation applies to Legacy BloodHound and is no longer maintained. +.. admonition:: Deprecated Documentation + :class: deprecated - See up-to-date documentation for BloodHound CE here: `Install BloodHound Community Edition with Docker Compose`_ + **This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).** -.. _Install BloodHound Community Edition with Docker Compose: https://support.bloodhoundenterprise.io/hc/en-us/articles/17468450058267 + Please use the `current BloodHound CE Documentation `_. + +.. meta:: + :canonical: https://bloodhound.specterops.io/get-started/quickstart/community-edition-quickstart Windows =======