Skip to content

Commit

Permalink
remove mermaid from documentation because it does noct work in airgap…
Browse files Browse the repository at this point in the history
…ped environments
  • Loading branch information
ekneg54 committed Oct 7, 2023
1 parent 7066488 commit 9fe76ea
Show file tree
Hide file tree
Showing 4 changed files with 0 additions and 139 deletions.
1 change: 0 additions & 1 deletion doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
sphinx
sphinx_rtd_theme
sphinxcontrib-mermaid
sphinxcontrib.datatemplates
sphinx-copybutton
nbsphinx
Expand Down
1 change: 0 additions & 1 deletion doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@ def setup(app):
# ones.
extensions = [
"sphinx.ext.napoleon",
"sphinxcontrib.mermaid",
"sphinx.ext.autosummary",
"sphinxcontrib.datatemplates",
"nbsphinx",
Expand Down
116 changes: 0 additions & 116 deletions doc/source/development/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,122 +2,6 @@
Development
===========

.. mermaid::

classDiagram
Component <-- Processor
Component <-- Connector
Connector <-- Input : implements
Connector <-- Output : implements
Processor <-- Normalizer : implements
Processor <-- Pseudonymizer : implements
Input <-- ConfluentKafkaInput : implements
Output <-- ConfluentKafkaOutput : implements
ProcessorConfiguration
Rule <-- NormalizerRule : inherit
Rule <-- PseudonymizerRule : inherit
BaseProcessorTestCase <-- NormalizerTestCase : implements
BaseProcessorTestCase <-- PseudonymizerTestCase : implements
class Component{
+Config
+str name
+Logger _logger
+Config _config
+String describe()
+None setup()
+None shut_down()

}
class Processor{
<<interface>>
+rule_class
+Config
+load_rules()
+process()
+apply_rules()*
}
class Normalizer{
+Config
+rule_class = NormalizerRule
+_config: Normalizer.Config
+apply_rules()
}

class Pseudonymizer{
+Config
+rule_class = PseudonymizerRule
+_config: Pseudonymizer.Config
+apply_rules()
}
class Connector{
<<interface>>
+Config
}
class Input{
<<interface>>
+Config
+_config: Input.Config
-Dict _get_event()*
-None _get_raw_event()
+tuple[dict, error|None] get_next()
}
class Output{
<<interface>>
+Config
+_config: Output.Config
+None store()*
+None store_custom()*
+None store_failed()*
}
class ConfluentKafkaInput{
+Config
+_config: ConfluentKafkaInput.Config
+tuple _get_event()
+bytearray _get_raw_event()
}
class ConfluentKafkaOutput{
+Config
+_config: ConfluentKafkaInput.Config
+None store()
+None store_custom()
+None store_failed()
}

class Configuration{
<<adapter>>
+create
}
class Registry{
+mapping : dict
}

class Factory{
+create()
}


class TestFactory{
+test_check()
+test_create_normalizer()
+test_create_pseudonymizer()
}

class BaseProcessorTestCase{
+test_describe()
+test_load_rules()
+test_process()
+test_apply_rules()*
}

class NormalizerTestCase{
+test_apply_rules()
}

class PseudonymizerTestCase{
+test_apply_rules()
}


.. toctree::
:maxdepth: 2

Expand Down
21 changes: 0 additions & 21 deletions doc/source/user_manual/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,27 +36,6 @@ Multiple instances of pipelines are created and run in parallel by different pro
Only one event at a time is processed by each processor.
Therefore, results of a processor should not depend on other events.

.. mermaid::

flowchart LR
A[Input\nConnector] --> B
A[Input\nConnector] --> C
A[Input\nConnector] --> D
subgraph Pipeline 1
B[Normalizer] --> E[Geo-IP Enricher]
E --> F[Dropper]
end
subgraph Pipeline 2
C[Normalizer] --> G[Geo-IP Enricher]
G --> H[Dropper]
end
subgraph Pipeline n
D[Normalizer] --> I[Geo-IP Enricher]
I --> J[Dropper]
end
F --> K[Output\nConnector]
H --> K[Output\nConnector]
J --> K[Output\nConnector]

Processors
==========
Expand Down

0 comments on commit 9fe76ea

Please sign in to comment.