Skip to content

Commit e7f15e1

Browse files
pradameinhofStephenHinck
pradameinhof
and
StephenHinck
authored
Read the docs deprecation notices and canonical links (#737)
* Updated readme to make deprecation more prominent * Added creators * Retriggering GitHub Actions * Deprecation notice updates * Changed verbiage and color of deprecation notice * Updated links to point to the new documentation * Added canonical links to point to new documentation for SEO * Updated index.rst * Trigger build (empty signed commit) * Revert "Updated index.rst" This reverts commit f11e387. * Revert "Deprecation notice updates" This reverts commit 0736820. * Re-commit with only source files --------- Co-authored-by: pradameinhof <pradameinhof@users.noreply.github.com> Co-authored-by: Stephen Hinck <shinck@specterops.io>
1 parent f9b7d91 commit e7f15e1

File tree

16 files changed

+122
-52
lines changed

16 files changed

+122
-52
lines changed

‎docs/_templates/layout.html‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{% extends "!layout.html" %}
2+
3+
{% block extrahead %}
4+
{{ super() }}
5+
{% if meta.canonical %}
6+
<link rel="canonical" href="{{ meta.canonical }}" />
7+
{% endif %}
8+
{% endblock %}

‎docs/conf.py‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,17 @@
5151
#
5252
html_theme = 'sphinx_rtd_theme'
5353

54+
# Canonical URL for SEO
55+
html_context = {
56+
"canonical_url": "https://bloodhound.specterops.io/"
57+
}
58+
59+
60+
# Load custom CSS so that deprecated notice boxes are displayed in red
61+
def setup(app):
62+
app.add_css_file('css/custom.css') # relative to _static/
63+
64+
5465
# Add any paths that contain custom static files (such as style sheets) here,
5566
# relative to this directory. They are copied after the builtin static files,
5667
# so a file named "default.css" will overwrite the builtin "default.css".

‎docs/data-analysis/bloodhound-gui.rst‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1-
.. note::
2-
This documentation applies to Legacy BloodHound and is no longer maintained.
1+
.. admonition:: Deprecated Documentation
2+
:class: deprecated
33

4-
See up-to-date documentation for BloodHound CE here: `BloodHound Support`_
4+
**This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).**
55

6-
.. _BloodHound Support: https://support.bloodhoundenterprise.io/hc/en-us
6+
Please use the `current BloodHound CE Documentation <https://bloodhound.specterops.io/analyze-data/bloodhound-gui/cypher-search>`_.
7+
8+
.. meta::
9+
:canonical: https://bloodhound.specterops.io/analyze-data/bloodhound-gui/cypher-search
710

811
The BloodHound GUI
912
==================

‎docs/data-analysis/edges.rst‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1-
.. note::
2-
This documentation applies to Legacy BloodHound and is no longer maintained.
1+
.. admonition:: Deprecated Documentation
2+
:class: deprecated
33

4-
See up-to-date documentation for BloodHound CE here: `About BloodHound Edges`_
4+
**This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).**
55

6-
.. _About BloodHound Edges: https://support.bloodhoundenterprise.io/hc/en-us/articles/17224136169371
6+
Please use the `current BloodHound CE Documentation <https://bloodhound.specterops.io/resources/edges/overview>`_.
7+
8+
.. meta::
9+
:canonical: https://bloodhound.specterops.io/resources/edges/overview
710

811
Edges
912
=====

‎docs/data-analysis/nodes.rst‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1-
.. note::
2-
This documentation applies to Legacy BloodHound and is no longer maintained.
1+
.. admonition:: Deprecated Documentation
2+
:class: deprecated
33

4-
See up-to-date documentation for BloodHound CE here: `About BloodHound Nodes`_
4+
**This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).**
55

6-
.. _About BloodHound Nodes: https://support.bloodhoundenterprise.io/hc/en-us/articles/17605671475867
6+
Please use the `current BloodHound CE Documentation <https://bloodhound.specterops.io/resources/nodes/overview>`_.
7+
8+
.. meta::
9+
:canonical: https://bloodhound.specterops.io/resources/nodes/overview
710

811
Nodes
912
=====

‎docs/data-collection/azurehound-all-flags.rst‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1-
.. note::
2-
This documentation applies to Legacy BloodHound and is no longer maintained.
1+
.. admonition:: Deprecated Documentation
2+
:class: deprecated
33

4-
See up-to-date documentation for BloodHound CE here: `All AzureHound Community Edition Flags, Explained`_
4+
**This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).**
55

6-
.. _All AzureHound Community Edition Flags, Explained: https://support.bloodhoundenterprise.io/hc/en-us/articles/17481642843803
6+
Please use the `current BloodHound CE Documentation <https://bloodhound.specterops.io/collect-data/ce-collection/azurehound-flags>`_.
7+
8+
.. meta::
9+
:canonical: https://bloodhound.specterops.io/collect-data/ce-collection/azurehound-flags
710

811
All AzureHound Flags, Explained
912
===============================

‎docs/data-collection/azurehound.rst‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1-
.. note::
2-
This documentation applies to Legacy BloodHound and is no longer maintained.
1+
.. admonition:: Deprecated Documentation
2+
:class: deprecated
33

4-
See up-to-date documentation for BloodHound CE here: `AzureHound Community Edition`_
4+
**This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).**
55

6-
.. _AzureHound Community Edition: https://support.bloodhoundenterprise.io/hc/en-us/articles/17481394564251
6+
Please use the `current BloodHound CE Documentation <https://bloodhound.specterops.io/collect-data/ce-collection/azurehound>`_.
7+
8+
.. meta::
9+
:canonical: https://bloodhound.specterops.io/collect-data/ce-collection/azurehound
710

811
AzureHound
912
==========

‎docs/data-collection/bloodhound-py.rst‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1-
.. note::
2-
This documentation applies to Legacy BloodHound and is no longer maintained.
1+
.. admonition:: Deprecated Documentation
2+
:class: deprecated
33

4-
See up-to-date documentation for BloodHound.py here: `BloodHound.py`_
4+
**This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).**
55

6-
.. _BloodHound.py: https://github.com/dirkjanm/BloodHound.py
6+
Please use the `current BloodHound CE Documentation <https://bloodhound.specterops.io/get-started/introduction>`_.
7+
8+
.. meta::
9+
:canonical: https://bloodhound.specterops.io/get-started/introduction
710

811

912
BloodHound.py

‎docs/data-collection/sharphound-all-flags.rst‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1-
.. note::
2-
This documentation applies to Legacy BloodHound and is no longer maintained.
1+
.. admonition:: Deprecated Documentation
2+
:class: deprecated
33

4-
See up-to-date documentation for BloodHound CE here: `All SharpHound Community Edition Flags, Explained`_
4+
**This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).**
55

6-
.. _All SharpHound Community Edition Flags, Explained: https://support.bloodhoundenterprise.io/hc/en-us/articles/17481375424795
6+
Please use the `current BloodHound CE Documentation <https://bloodhound.specterops.io/collect-data/ce-collection/sharphound-flags>`_.
7+
8+
.. meta::
9+
:canonical: https://bloodhound.specterops.io/collect-data/ce-collection/sharphound-flags
710

811
All SharpHound Flags, Explained
912
===============================

‎docs/data-collection/sharphound.rst‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
1-
.. note::
2-
This documentation applies to Legacy BloodHound and is no longer maintained.
1+
.. admonition:: Deprecated Documentation
2+
:class: deprecated
33

4-
See up-to-date documentation for BloodHound CE here: `SharpHound CE`_
4+
**This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).**
5+
6+
Please use the `current BloodHound CE Documentation <https://bloodhound.specterops.io/collect-data/ce-collection/sharphound>`_.
7+
8+
.. meta::
9+
:canonical: https://bloodhound.specterops.io/collect-data/ce-collection/sharphound
510

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

812
SharpHound
913
==========

0 commit comments

Comments
 (0)