Hi Aniss,
could you enhance the patch description?

It's common practice to prefix with the path that has been modified,
in your case "docs: ".

Instead of generic "Add documentation", please change to something like
"add BondRecipe documentation"

So, when put together it could look like:
"docs: add BondRecipe documentation"

-Jan

Thu, Sep 24, 2020 at 10:13:38PM CEST, aloughla@redhat.com wrote:
>From: Aniss Loughlam <aloughla@redhat.com>
>
>Signed-off-by: Aniss Loughlam <aloughla@redhat.com>
>---
> docs/source/bond_recipe.rst        | 6 ++++++
> docs/source/specific_scenarios.rst | 1 +
> 2 files changed, 7 insertions(+)
> create mode 100644 docs/source/bond_recipe.rst
>
>diff --git a/docs/source/bond_recipe.rst b/docs/source/bond_recipe.rst
>new file mode 100644
>index 0000000..921ceaf
>--- /dev/null
>+++ b/docs/source/bond_recipe.rst
>@@ -0,0 +1,6 @@
>+BondRecipe
>+^^^^^^^^^^^^^^^^^^^
>+
>+.. autoclass:: lnst.Recipes.ENRT.BondRecipe.BondRecipe
>+    :members:
>+    :show-inheritance:
>diff --git a/docs/source/specific_scenarios.rst b/docs/source/specific_scenarios.rst
>index b78577c..ee70313 100644
>--- a/docs/source/specific_scenarios.rst
>+++ b/docs/source/specific_scenarios.rst
>@@ -3,6 +3,7 @@ Specific ENRT scenarios
>
> .. toctree::
>     simple_network_recipe
>+    bond_recipe
>     team_recipe
>     vlans_recipe
>     vlans_over_bond_recipe
>--
>2.25.4
>_______________________________________________
>LNST-developers mailing list -- lnst-developers@lists.fedorahosted.org
>To unsubscribe send an email to lnst-developers-leave@lists.fedorahosted.org
>Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/
>List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
>List Archives: https://lists.fedorahosted.org/archives/list/lnst-developers@lists.fedorahosted.org