Add contributing guide

Add refs for tshoot and diag info tools

Change-Id: Ibdcc415c33edb1b2cb4a062539b9262ac82e5e7c
Signed-off-by: Bogdan Dobrelya <bdobrelia@mirantis.com>
This commit is contained in:
Bogdan Dobrelya 2016-09-08 13:18:24 +02:00
parent 6268f37ac2
commit 90dfd92352
4 changed files with 30 additions and 0 deletions

View File

@ -1,3 +1,5 @@
.. _diag-info-tools:
Diagnostic info collection tools
================================

View File

@ -0,0 +1,22 @@
.. _CONTRIBUTING:
=================
How To Contribute
=================
General info
============
#. Bugs should be filed on CCP launchpad_, not GitHub.
#. Bugs related to Kubernetes installation process should be filed as
Kargo_ GitHub issues.
#. Please follow OpenStack `Gerrit Workflow`_ to contribute to CCP installer.
.. _launchpad: https://bugs.launchpad.net/fuel-ccp
.. _Kargo: https://github.com/kubespray/kargo/issues
.. _Gerrit Workflow: http://docs.openstack.org/infra/manual/developers.html#development-workflow
Please always generate and attach a diagnostic info tarball to submitted
bugs! See :ref:`Diagnostic info tool<diag-info-tools>` and :ref:`Troubleshooting<tshoot>`.

View File

@ -12,6 +12,7 @@ Contents
.. toctree::
:maxdepth: 1
contributing
quickstart
troubleshooting
inventory_repo

View File

@ -1,3 +1,5 @@
.. _tshoot:
===============
Troubleshooting
===============
@ -16,3 +18,6 @@ netfilter for bridge interfaces is disabled for your host node(s):
Otherwise, bird daemon inside Calico won't function correctly because of
libvirt and NAT networks. More details can be found in this
`bug <https://bugzilla.redhat.com/show_bug.cgi?id=512206>`_.
Then reporting issues, please also make sure to include details on the host
OS type and its kernel version.