docs: add tutorial

sophos · Nov 8, 2024 · 8600647 · 8600647
1 parent f637af1
commit 8600647
Show file tree

Hide file tree

Showing 36 changed files with 364 additions and 23,188 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@ tests/output/
 tests/integration/inventory
 changelogs/.plugin-cache.yaml
 *.tar.gz
+group_vars/all/credentials.yml
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -5,3 +5,4 @@
 # Created with antsibull-docs 2.14.0
 
 /build
+/rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -8,7 +8,7 @@
 # documentation:
 # http://www.sphinx-doc.org/en/master/config
 
-project = 'Sophos Firewall'
+project = 'Sophos.Sophos_Firewall'
 copyright = 'Sophos, Ltd.'
 
 title = 'Sophos Firewall Ansible Collection'
@@ -21,6 +21,7 @@
 highlight_language = 'YAML+Jinja'
 
 html_theme = 'sphinx_ansible_theme'
+
 html_show_sphinx = False
 
 display_version = False
@@ -32,6 +33,7 @@
 
 html_static_path = ['static']
 
+
 # See https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_mapping for the syntax
 intersphinx_mapping = {
     'python': ('https://docs.python.org/2/', (None, '../python2.inv')),

diff --git a/docs/docsite/extra-docs.yml b/docs/docsite/extra-docs.yml
@@ -1,5 +1,6 @@
 sections:
-  - title: Installation and Setup
+  - title: Getting Started
     toctree:
       - installation
-      - setup
+      - setup
+      - tutorial
diff --git a/docs/docsite/rst/installation.rst b/docs/docsite/rst/installation.rst
@@ -11,15 +11,16 @@ The following must be installed prior to installing the module:
 * Ansible 2.16+
 * sophosfirewall-python 0.1.56+
 
-The sophosfirewall-python module can be installed with ``pip``:
+With Python installed on the system, Ansible and the sophosfirewall-python module can be installed with ``pip``:
 
 .. code-block:: bash
 
+    $ pip install ansible
     $ pip install sophosfirewall-python
 
 Install
 -------
-The Sophos Firewall Ansible Collection can be installed using the ``ansible-galaxy`` command-line utility:
+The Sophos Firewall Ansible Collection can be installed using the ``ansible-galaxy`` utility which is included with Ansible:
 
 .. code-block:: bash
 

diff --git a/docs/docsite/rst/setup.rst b/docs/docsite/rst/setup.rst
@@ -1,7 +1,7 @@
 .. _ansible_collections.sophos.sophos_firewall.docsite.setup:
 
-Setup
-=====
+Required Firewall Setup
+=======================
 Prior to using the Ansible modules, the firewall must be set up to allow access to the API
 from the IP address of the system running Ansible.
 

diff --git a/docs/docsite/rst/tutorial.rst b/docs/docsite/rst/tutorial.rst
diff --git a/docs/rst/changelog.rst b/docs/rst/changelog.rst
diff --git a/docs/rst/docsite/installation.rst b/docs/rst/docsite/installation.rst
diff --git a/docs/rst/docsite/setup.rst b/docs/rst/docsite/setup.rst
diff --git a/docs/rst/environment_variables.rst b/docs/rst/environment_variables.rst
diff --git a/docs/rst/index.rst b/docs/rst/index.rst
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,3 +5,4 @@
		# Created with antsibull-docs 2.14.0

		/build
		/rst