diff --git a/doc/source/collect_info.rst b/doc/source/collect_info.rst index a0a66f8..ec94be6 100644 --- a/doc/source/collect_info.rst +++ b/doc/source/collect_info.rst @@ -1,3 +1,5 @@ +.. _diag-info-tools: + Diagnostic info collection tools ================================ diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst new file mode 100644 index 0000000..9d74baa --- /dev/null +++ b/doc/source/contributing.rst @@ -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` and :ref:`Troubleshooting`. diff --git a/doc/source/index.rst b/doc/source/index.rst index 2ae5dc9..0dd856b 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -12,6 +12,7 @@ Contents .. toctree:: :maxdepth: 1 + contributing quickstart troubleshooting inventory_repo diff --git a/doc/source/troubleshooting.rst b/doc/source/troubleshooting.rst index 64354ea..98a60c7 100644 --- a/doc/source/troubleshooting.rst +++ b/doc/source/troubleshooting.rst @@ -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 `_. + +Then reporting issues, please also make sure to include details on the host +OS type and its kernel version.