minor docs updates

superstes · superstes · commit 96bf6d95c1f8 · 2025-09-06T22:55:06.000+02:00
diff --git a/docs/source/_include/warn_develop.rst b/docs/source/_include/warn_develop.rst
@@ -1,2 +1,2 @@
 .. warning::
-    This project still in early development! **DO NOT USE IN PRODUCTION!**
+    This project still in early development!
diff --git a/docs/source/_include/warn_wip.rst b/docs/source/_include/warn_wip.rst
@@ -0,0 +1,2 @@
+.. warning::
+    This documentation is still work-in-progress!
diff --git a/docs/source/dev/1_intro.rst b/docs/source/dev/1_intro.rst
@@ -156,7 +156,7 @@ The network-traffic configuration as provided by the user is parsed to packets.
 3. Config Loader
 ================
 
-**Files**: :code:`src/firewall_test/simulator/loader.py`, :code:`src/firewall_test/plugins/system/config.py` (mapping target-system to translate-plugins), :code:`:code:`src/firewall_test/system/*` (target-system config), :code:`/home/rath/code/firewall-testing-framework/src/firewall_test/plugins/translate/*` (translate plugins)
+**Files**: :code:`src/firewall_test/simulator/loader.py`, :code:`src/firewall_test/plugins/system/config.py` (mapping target-system to translate-plugins), :code:`src/firewall_test/system/*` (target-system config), :code:`/home/rath/code/firewall-testing-framework/src/firewall_test/plugins/translate/*` (translate plugins)
 
 The configuration-files provided by the user are loaded and parsed as configured for the target firewall-system.
 
@@ -202,7 +202,7 @@ The configuration-files provided by the user are loaded and parsed as configured
 
   .. tip::
 
-      The detailed function of the :ref:`routing- and firewall-simulators are covered later on <dev_intro_router>`_.
+      The detailed function of the :ref:`routing- and firewall-simulators are covered later on <dev_intro_router>`.
 
 4. **Pre-Routing and Pre-DNAT Firewall-Filters are processed**
 
@@ -254,6 +254,8 @@ Routing & Firewalling
 
 .. _dev_intro_router:
 
+.. include:: ../_include/warn_wip.rst
+
 Routing Simulator
 =================
 
diff --git a/docs/source/dev/2_plugins.rst b/docs/source/dev/2_plugins.rst
@@ -9,4 +9,4 @@
 Plugin Development
 ##################
 
-tbd
+.. include:: ../_include/warn_wip.rst
diff --git a/docs/source/plugins/firewall_opnsense.rst b/docs/source/plugins/firewall_opnsense.rst
@@ -6,9 +6,7 @@
 Firewall - OPNsense
 ===================
 
-.. warning::
-
-    This plugin is still in early development!
+.. include:: ../_include/warn_develop.rst
 
 Config Export
 #############
@@ -22,7 +20,7 @@ Config Export
 Run
 ###
 
-tbd
+.. include:: ../_include/warn_wip.rst
 
 ----
 
diff --git a/docs/source/usage/1_intro.rst b/docs/source/usage/1_intro.rst
@@ -9,6 +9,8 @@
 1 - Intro
 =========
 
+|topology|
+
 Goal / Reason / Why?
 ####################
 
@@ -96,6 +98,3 @@ Please take a took `at the roadmap <https://github.com/O-X-L/firewall-testing-fr
   * finds the route the packet should take
   * tests the traffic against the rulesets of firewalls that are hops of that route
 
-Take a look at this topology:
-
-|topology|
diff --git a/docs/source/usage/3_run.rst b/docs/source/usage/3_run.rst
@@ -197,15 +197,11 @@ Depending on the system-specific configuration traffic can be dropped by non-fir
 Automated for CI
 ================
 
-.. warning::
-
-    Still under development.
+.. include:: ../_include/warn_develop.rst
 
 ----
 
 Interactive Shell
 =================
 
-.. warning::
-
-    Still under development.
+.. include:: ../_include/warn_develop.rst
diff --git a/docs/source/usage/4_config.rst b/docs/source/usage/4_config.rst
@@ -6,4 +6,4 @@
 4 - Config
 ==========
 
-tbd
+.. include:: ../_include/warn_wip.rst

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`.. warning::`
`2`		`- This project still in early development! DO NOT USE IN PRODUCTION!`
	`2`	`+ This project still in early development!`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+.. warning::`
	`2`	`+ This documentation is still work-in-progress!`