Skip to content

Read the docs deprecation notices and canonical links #737

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
elikmiller merged 10 commits into from
May 6, 2025
Merged

Read the docs deprecation notices and canonical links #737

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
cc3e43d
Updated readme to make deprecation more prominent
pradameinhof Apr 1, 2025
806b8ff
Added creators
pradameinhof Apr 1, 2025
b9987f2
Retriggering GitHub Actions
pradameinhof Apr 1, 2025
0736820
Deprecation notice updates
pradameinhof Apr 18, 2025
f11e387
Updated index.rst
pradameinhof Apr 18, 2025
967d09f
Trigger build (empty signed commit)
pradameinhof Apr 18, 2025
fd42029
Revert "Updated index.rst"
pradameinhof Apr 23, 2025
6675198
Revert "Deprecation notice updates"
pradameinhof Apr 23, 2025
5ae0124
Re-commit with only source files
pradameinhof Apr 23, 2025
dad7cba
Merge branch 'master' of github.com:SpecterOps/BloodHound-Legacy into…
StephenHinck May 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/_templates/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{% extends "!layout.html" %}

{% block extrahead %}
{{ super() }}
{% if meta.canonical %}
<link rel="canonical" href="{{ meta.canonical }}" />
{% endif %}
{% endblock %}
11 changes: 11 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,17 @@
#
html_theme = 'sphinx_rtd_theme'

# Canonical URL for SEO
html_context = {
"canonical_url": "https://bloodhound.specterops.io/"
}


# 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".
Expand Down
11 changes: 7 additions & 4 deletions docs/data-analysis/bloodhound-gui.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <https://bloodhound.specterops.io/analyze-data/bloodhound-gui/cypher-search>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/analyze-data/bloodhound-gui/cypher-search

The BloodHound GUI
==================
Expand Down
11 changes: 7 additions & 4 deletions docs/data-analysis/edges.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <https://bloodhound.specterops.io/resources/edges/overview>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/resources/edges/overview

Edges
=====
Expand Down
11 changes: 7 additions & 4 deletions docs/data-analysis/nodes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <https://bloodhound.specterops.io/resources/nodes/overview>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/resources/nodes/overview

Nodes
=====
Expand Down
11 changes: 7 additions & 4 deletions docs/data-collection/azurehound-all-flags.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <https://bloodhound.specterops.io/collect-data/ce-collection/azurehound-flags>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/collect-data/ce-collection/azurehound-flags

All AzureHound Flags, Explained
===============================
Expand Down
11 changes: 7 additions & 4 deletions docs/data-collection/azurehound.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <https://bloodhound.specterops.io/collect-data/ce-collection/azurehound>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/collect-data/ce-collection/azurehound

AzureHound
==========
Expand Down
11 changes: 7 additions & 4 deletions docs/data-collection/bloodhound-py.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <https://bloodhound.specterops.io/get-started/introduction>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/get-started/introduction


BloodHound.py
Expand Down
11 changes: 7 additions & 4 deletions docs/data-collection/sharphound-all-flags.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <https://bloodhound.specterops.io/collect-data/ce-collection/sharphound-flags>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/collect-data/ce-collection/sharphound-flags

All SharpHound Flags, Explained
===============================
Expand Down
12 changes: 8 additions & 4 deletions docs/data-collection/sharphound.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <https://bloodhound.specterops.io/collect-data/ce-collection/sharphound>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/collect-data/ce-collection/sharphound

.. _SharpHound CE: https://support.bloodhoundenterprise.io/hc/en-us/articles/17481151861019

SharpHound
==========
Expand Down
11 changes: 7 additions & 4 deletions docs/further-reading/further-reading.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <https://bloodhound.specterops.io/collect-data/ce-collection/overview>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/collect-data/ce-collection/overview

Further Reading/Viewing
=======================
Expand Down
11 changes: 7 additions & 4 deletions docs/further-reading/json.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <https://bloodhound.specterops.io/integrations/bloodhound-api/working-with-api>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/integrations/bloodhound-api/working-with-api

BloodHound JSON Formats
=======================
Expand Down
11 changes: 11 additions & 0 deletions docs/html/_static/css/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
}
11 changes: 7 additions & 4 deletions docs/installation/linux.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <https://bloodhound.specterops.io/get-started/quickstart/community-edition-quickstart>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/get-started/quickstart/community-edition-quickstart

Linux
=====
Expand Down
11 changes: 7 additions & 4 deletions docs/installation/osx.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <https://bloodhound.specterops.io/get-started/quickstart/community-edition-quickstart>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/get-started/quickstart/community-edition-quickstart

macOS
=====
Expand Down
11 changes: 7 additions & 4 deletions docs/installation/windows.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <https://bloodhound.specterops.io/get-started/quickstart/community-edition-quickstart>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/get-started/quickstart/community-edition-quickstart

Windows
=======
Expand Down
Loading