Merge pull request #20 from cmeissner/community_files

Adapt community information

Author: cmeissner

.github/ISSUE_TEMPLATE/bug_report.md

@@ -18,9 +18,10 @@ Steps to reproduce the behavior:
 A clear and concise description of what you expected to happen.
 
 **Versions:**
- - Ansible:
- - phpipam-ansible-modules
- - phpypam
+
+- Ansible:
+- phpipam-ansible-modules
+- phpypam
 
 **Additional context**
 Add any other context about the problem here.

CONTRIBUTING.md

@@ -0,0 +1,41 @@
+# How to contribute to phpipam-ansible-modules
+
+## Did you found a bug
+
+* Do not open Github issue it the bug concerns [{php}IPAM](https://github.com/phpipam/phpipam) and not the ansible modules.
+
+* Make sure the bug is not already opened by another user.
+
+* If you can't find an open issue which reflects your observed problem go ahead an [open a new bug](https://github.com/codeaffen/phpipam-ansible-modules/issues/new?assignees=&labels=bug&template=bug_report.md&title=).
+
+* Provide as much information as mentioned in the bug report template.
+
+## Did you wrote a patch for an open bug
+
+* Open new pull request containing the patch.
+
+* Provide a clear description which describes the problem and the solution. Link the existing bug to the PR.
+
+## Do you want to add a new feature
+
+* Make sure there isn't already a feature request.
+
+* If you can't find an open feature request which describe your feature idea or parts of it feel free to [open a new feature request](https://github.com/codeaffen/phpipam-ansible-modules/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=).
+
+* Suggest your feature idea within the created feature request.
+
+* Provide as much discribtion as possible to enable others to have a good understanding of what you are doing.
+
+* Point out that you want to start to work on the new feature
+
+## Do you wnat to contribute to documentation
+
+* Write you documentation change.
+
+* Open a PR with your change.
+
+* Discuss with the team about your changes.
+
+## Thank you for any contribution
+
+We will thank you for heed the contribution guidelines and we encourage you to contribute and join the team.

README.md

@@ -1,8 +1,4 @@
-# phpipam-ansible-modules
-
-## work in progress
-
-**This modules are still in development and not for production purpose. If we think you can use is in a more productive manner we will inform you.**
+# phpIPAM Ansible Modules
 
 This collection provides modules to manage entities in a [phpIPAM](https://phpipam.net/). This is neighter a collection of roles nor playbooks. It provides modules to wrote your own roles and/or playbooks.
 
@@ -157,7 +153,7 @@ EXAMPLES:
 
 ### repository folder
 
-A last option to read the docs is the [docs](docs) folder in this repository.
+A last option to read the docs is the docs folder in this repository.
 
 ## Dependencies
 

docs/CONTRIBUTING.md

@@ -0,0 +1 @@
+../CONTRIBUTING.md

docs/conf.py

@@ -19,9 +19,9 @@
 
 # -- Project information -----------------------------------------------------
 
-project = u'phpipam-ansible-modules'
-copyright = u'2020, Christian Meißner'
-author = u'Christian Meißner'
+project = u'phpIPAM Ansible Modules'
+copyright = u'2020, codeaffen'
+author = u'codeaffen'
 
 # The short X.Y version
 version = u''
@@ -39,8 +39,10 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    'recommonmark',
     'sphinx.ext.autodoc',
-    'sphinx_ansible_theme',
+    'sphinx.ext.intersphinx',
+    'ansible_basic_sphinx_ext',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -50,7 +52,10 @@
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
 
 # The master toctree document.
 master_doc = 'index'
@@ -76,7 +81,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_ansible_theme'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

docs/index.rst

@@ -3,7 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to phpipam-ansible-modules's documentation!
+Welcome to phpIPAM Ansible Module documentation!
 ===================================================
 
 .. toctree::
@@ -14,6 +14,12 @@ Welcome to phpipam-ansible-modules's documentation!
    Changelog <CHANGELOG>
    plugins/index
 
+.. toctree::
+   :maxdepth: 2
+   :caption: Developer documentation
+
+   Contributing <CONTRIBUTING>
+
 Indices and tables
 ==================
 

docs/requirements.txt

@@ -1,5 +1,5 @@
 antsibull>=0.17.0
 ansible-base>=2.10.0rc2
 sphinx-rtd-theme
-sphinx-ansible-theme
+git+https://github.com/felixfontein/ansible-basic-sphinx-ext
 recommonmark