user guide changed

Author: Jannis-Mittenzwei

doc/user_guide/overview.rst doc/user_guide/features.rstdoc/user_guide/overview.rst renamed to doc/user_guide/features.rst

@@ -1,8 +1,8 @@
-Overview
+Features
 ========
 
-Project Layout 
---------------
+Uniformed Project Layout
+------------------------
 
 Overall, the toolbox generally expects a certain project layout because it tries to follow the credo "convention over configuration" when possible and reasonable. This expected structure can be better understood by looking at the cookie-cutter project template, which is part of the python-toolbox workspace and can be found in `project-template`. One can also generate a project from the template to explore the default structure. For more details on this, please check out the getting started section.
 
@@ -16,3 +16,16 @@ Central files in regards to nox and the toolbox are:
 
 - noxfile.py: Standard nox configuration/setup file
 - noxconfig.py: Exasol-specific file containing additional information needed by the standard tasks of the toolbox
+
+Important Nox Commands
+^^^^^^^^^^^^^^^^^^^^^^
+
+* :code:`nox -l` this command shows a list of all available nox tasks
+* :code:`nox -s <tasks>` to run the specified task(s)
+    * :code:`nox -s test:typing` which runs the type checker on the project
+    * :code:`nox -s docs:clean docs:build docs:open`
+        #. first task removes the documentation folder
+        #. second one builds the documentation
+        #. last one opens the documentation in the web browser
+* :code:`nox` without :code:`-s` runs the default task which is
+    * :code:`nox -s fix` this command runs automated fixes on the code

doc/user_guide/how_to_release.rst

@@ -0,0 +1,11 @@
+How to Release
+==============
+
+#.  Use the command :code:`nox -s release:prepare` to prepare the project for a new release.
+#.  Merge your **Pull Request** to main
+#.  Switch the **current branch** to the **default branch**
+#.  Ensure default branch to be up to date: :code:`git pull`
+#.  Set your **tag name**: :code:`TAG=...`
+#.  Use :code:`git tag "${TAG}"` to create a new tag in your repo
+#.  Use :code:`git push origin "${TAG}"` to push it in your remote repo
+#.  GitHub workflow reacts on this tag and starts the release process

doc/user_guide/user_guide.rst

@@ -6,8 +6,9 @@
 .. toctree::
     :maxdepth: 2
 
-    overview
     getting_started
+    features
     workflows
     customization
     migrating
+    how_to_release