Skip to content
This repository was archived by the owner on Aug 25, 2024. It is now read-only.

Commit cd504db

Browse files
committed
docs: examples: shouldi: Fix cross references
Signed-off-by: John Andersen <johnandersenpdx@gmail.com>
1 parent 63a699a commit cd504db

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

docs/examples/dataflows.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
DataFlow HTTP Deployment
22
========================
33

4-
In the :doc:`/tutorials/operations` we created a command line meta static
4+
In the :doc:`/examples/shouldi` we created a command line meta static
55
analysis tool, ``shouldi``.
66

77
.. code-block:: console
@@ -12,7 +12,7 @@ analysis tool, ``shouldi``.
1212
safety_check.outputs.result: 1
1313
run_bandit.outputs.result: {'CONFIDENCE.HIGH': 0.0, 'CONFIDENCE.LOW': 0.0, 'CONFIDENCE.MEDIUM': 0.0, 'CONFIDENCE.UNDEFINED': 0.0, 'SEVERITY.HIGH': 0.0, 'SEVERITY.LOW': 0.0, 'SEVERITY.MEDIUM': 0.0, 'SEVERITY.UNDEFINED': 0.0, 'loc': 100, 'nosec': 0, 'CONFIDENCE.HIGH_AND_SEVERITY.LOW': 0, 'CONFIDENCE.HIGH_AND_SEVERITY.MEDIUM': 0, 'CONFIDENCE.HIGH_AND_SEVERITY.HIGH': 0}
1414
15-
In the :ref:`tutorials_operations_registering_opreations` section of the
15+
In the :ref:`examples_shouldi_registering_opreations` section of the
1616
operations tutorial, we registered our operations with Python's ``entrypoint``
1717
system. This allows other Python packages and DFFML plugins to access them
1818
without the need to hardcode in ``import`` statements.
@@ -59,7 +59,7 @@ to look at JSON.
5959
$ python3 -m pip install dffml-config-yaml
6060
6161
We'll be working from the top level directory of the ``shouldi`` package we
62-
created in the :doc:`/tutorials/operations`.
62+
created in the :doc:`/examples/shouldi`.
6363

6464
The source for that package is also available under the ``examples/shouldi``
6565
directory of the DFFML source code.
@@ -69,8 +69,8 @@ directory of the DFFML source code.
6969
$ cd examples/shouldi
7070
7171
Config files are named after the dataflow they are associated with. In the
72-
:ref:`tutorials_operations_visualizing_the_dataflow` section of the
73-
:doc:`/tutorials/operations`, we serialized the ``shouldi`` dataflow to the
72+
:ref:`examples_shouldi_visualizing_the_dataflow` section of the
73+
:doc:`/examples/shouldi`, we serialized the ``shouldi`` dataflow to the
7474
``shouldi/deploy/df`` directory.
7575

7676
The ``df`` directory is contains the main dataflows to be deployed.

docs/examples/shouldi.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -458,7 +458,7 @@ is set up correctly).
458458
safety_check.outputs.result: 1
459459
run_bandit.outputs.result: {'CONFIDENCE.HIGH': 0.0, 'CONFIDENCE.LOW': 0.0, 'CONFIDENCE.MEDIUM': 0.0, 'CONFIDENCE.UNDEFINED': 0.0, 'SEVERITY.HIGH': 0.0, 'SEVERITY.LOW': 0.0, 'SEVERITY.MEDIUM': 0.0, 'SEVERITY.UNDEFINED': 0.0, 'loc': 100, 'nosec': 0, 'CONFIDENCE.HIGH_AND_SEVERITY.LOW': 0, 'CONFIDENCE.HIGH_AND_SEVERITY.MEDIUM': 0, 'CONFIDENCE.HIGH_AND_SEVERITY.HIGH': 0}
460460
461-
.. _tutorials_operations_visualizing_the_dataflow:
461+
.. _examples_shouldi_visualizing_the_dataflow:
462462

463463
Visualizing the DataFlow
464464
------------------------
@@ -530,7 +530,7 @@ It should render the following SVG showing how all the operations are connected.
530530
GitLab will render mermaidjs diagrams found in markdown files. There is also a
531531
sphinx plugin, and a command line utility.
532532

533-
.. _tutorials_operations_registering_opreations:
533+
.. _examples_shouldi_registering_opreations:
534534

535535
Registering Operations
536536
----------------------

0 commit comments

Comments
 (0)