diff --git a/playbooks/roles/rsyslog_client/CONTRIBUTING.rst b/playbooks/roles/rsyslog_client/CONTRIBUTING.rst index 5c0ce81b2e..c3f2ebcd91 100644 --- a/playbooks/roles/rsyslog_client/CONTRIBUTING.rst +++ b/playbooks/roles/rsyslog_client/CONTRIBUTING.rst @@ -9,43 +9,55 @@ contributor guidelines Filing Bugs ----------- -Bugs should be filed on Launchpad, not GitHub: "https://bugs.launchpad.net/openstack-ansible" +Bugs should be filed on Launchpad, not GitHub: +"https://bugs.launchpad.net/openstack-ansible" -When submitting a bug, or working on a bug, please ensure the following criteria are met: - * The description clearly states or describes the original problem or root cause of the problem. - * Include historical information on how the problem was identified. - * Any relevant logs are included. - * The provided information should be totally self-contained. External access to web services/sites should not be needed. - * Steps to reproduce the problem if possible. +When submitting a bug, or working on a bug, please ensure the following +criteria are met: + +* The description clearly states or describes the original problem or root + cause of the problem. +* Include historical information on how the problem was identified. +* Any relevant logs are included. +* The provided information should be totally self-contained. External access + to web services/sites should not be needed. +* Steps to reproduce the problem if possible. Submitting Code --------------- -Changes to the project should be submitted for review via the Gerrit tool, following -the workflow documented at: "http://docs.openstack.org/infra/manual/developers.html#development-workflow" +Changes to the project should be submitted for review via the Gerrit tool, +following the workflow documented at: +"http://docs.openstack.org/infra/manual/developers.html#development-workflow" -Pull requests submitted through GitHub will be ignored and closed without regard. +Pull requests submitted through GitHub will be ignored and closed without +regard. Extra ----- Tags: - If it's a bug that needs fixing in a branch in addition to Master, add a '\-backport-potential' tag (eg ``juno-backport-potential``). There are predefined tags that will autocomplete. + If it's a bug that needs fixing in a branch in addition to Master, add a + '\-backport-potential' tag (eg ``juno-backport-potential``). + There are predefined tags that will autocomplete. Status: Please leave this alone, it should be New till someone triages the issue. Importance: - Should only be touched if it is a Blocker/Gating issue. If it is, please set to High, and only use Critical if you have found a bug that can take down whole infrastructures. + Should only be touched if it is a Blocker/Gating issue. If it is, please + set to High, and only use Critical if you have found a bug that can take + down whole infrastructures. Style guide ----------- -When creating tasks and other roles for use in Ansible please create then using the YAML dictionary format. +When creating tasks and other roles for use in Ansible please create then +using the YAML dictionary format. Example YAML dictionary format: .. code-block:: yaml @@ -69,17 +81,23 @@ Example **NOT** in YAML dictionary format: - some-other-tag -Usage of the ">" and "|" operators should be limited to Ansible conditionals and command modules such as the ansible ``shell`` module. +Usage of the ">" and "|" operators should be limited to Ansible conditionals +and command modules such as the ansible ``shell`` module. Issues ------ -When submitting an issue, or working on an issue please ensure the following criteria are met: - * The description clearly states or describes the original problem or root cause of the problem. - * Include historical information on how the problem was identified. - * Any relevant logs are included. - * If the issue is a bug that needs fixing in a branch other than Master, add the ‘backport potential’ tag TO THE ISSUE (not the PR). - * The provided information should be totally self-contained. External access to web services/sites should not be needed. - * If the issue is needed for a hotfix release, add the 'expedite' label. - * Steps to reproduce the problem if possible. +When submitting an issue, or working on an issue please ensure the following +criteria are met: + +* The description clearly states or describes the original problem or root + cause of the problem. +* Include historical information on how the problem was identified. +* Any relevant logs are included. +* If the issue is a bug that needs fixing in a branch other than Master, add + the ‘backport potential’ tag TO THE ISSUE (not the PR). +* The provided information should be totally self-contained. External access + to web services/sites should not be needed. +* If the issue is needed for a hotfix release, add the 'expedite' label. +* Steps to reproduce the problem if possible. diff --git a/playbooks/roles/rsyslog_server/CONTRIBUTING.rst b/playbooks/roles/rsyslog_server/CONTRIBUTING.rst index 2517d0bd47..3abcbe998f 100644 --- a/playbooks/roles/rsyslog_server/CONTRIBUTING.rst +++ b/playbooks/roles/rsyslog_server/CONTRIBUTING.rst @@ -9,43 +9,55 @@ contributor guidelines Filing Bugs ----------- -Bugs should be filed on Launchpad, not GitHub: "https://bugs.launchpad.net/openstack-ansible" +Bugs should be filed on Launchpad, not +GitHub: "https://bugs.launchpad.net/openstack-ansible" -When submitting a bug, or working on a bug, please ensure the following criteria are met: - * The description clearly states or describes the original problem or root cause of the problem. - * Include historical information on how the problem was identified. - * Any relevant logs are included. - * The provided information should be totally self-contained. External access to web services/sites should not be needed. - * Steps to reproduce the problem if possible. +When submitting a bug, or working on a bug, please ensure the following +criteria are met: + +* The description clearly states or describes the original problem or root + cause of the problem. +* Include historical information on how the problem was identified. +* Any relevant logs are included. +* The provided information should be totally self-contained. External + access to web services/sites should not be needed. +* Steps to reproduce the problem if possible. Submitting Code --------------- -Changes to the project should be submitted for review via the Gerrit tool, following -the workflow documented at: "http://docs.openstack.org/infra/manual/developers.html#development-workflow" +Changes to the project should be submitted for review via the Gerrit tool, +following the workflow documented at: +"http://docs.openstack.org/infra/manual/developers.html#development-workflow" -Pull requests submitted through GitHub will be ignored and closed without regard. +Pull requests submitted through GitHub will be ignored and closed without +regard. Extra ----- Tags: - If it's a bug that needs fixing in a branch in addition to Master, add a '\-backport-potential' tag (eg ``juno-backport-potential``). There are predefined tags that will autocomplete. + If it's a bug that needs fixing in a branch in addition to Master, add a + '\-backport-potential' tag (eg ``juno-backport-potential``). + There are predefined tags that will autocomplete. Status: Please leave this alone, it should be New till someone triages the issue. Importance: - Should only be touched if it is a Blocker/Gating issue. If it is, please set to High, and only use Critical if you have found a bug that can take down whole infrastructures. + Should only be touched if it is a Blocker/Gating issue. If it is, please + set to High, and only use Critical if you have found a bug that can take + down whole infrastructures. Style guide ----------- -When creating tasks and other roles for use in Ansible please create then using the YAML dictionary format. +When creating tasks and other roles for use in Ansible please create then +using the YAML dictionary format. Example YAML dictionary format: .. code-block:: yaml @@ -69,17 +81,23 @@ Example **NOT** in YAML dictionary format: - some-other-tag -Usage of the ">" and "|" operators should be limited to Ansible conditionals and command modules such as the ansible ``shell`` module. +Usage of the ">" and "|" operators should be limited to Ansible conditionals +and command modules such as the ansible ``shell`` module. Issues ------ -When submitting an issue, or working on an issue please ensure the following criteria are met: - * The description clearly states or describes the original problem or root cause of the problem. - * Include historical information on how the problem was identified. - * Any relevant logs are included. - * If the issue is a bug that needs fixing in a branch other than Master, add the ‘backport potential’ tag TO THE ISSUE (not the PR). - * The provided information should be totally self-contained. External access to web services/sites should not be needed. - * If the issue is needed for a hotfix release, add the 'expedite' label. - * Steps to reproduce the problem if possible. +When submitting an issue, or working on an issue please ensure the following +criteria are met: + +* The description clearly states or describes the original problem or root + cause of the problem. +* Include historical information on how the problem was identified. +* Any relevant logs are included. +* If the issue is a bug that needs fixing in a branch other than Master, + add the ‘backport potential’ tag TO THE ISSUE (not the PR). +* The provided information should be totally self-contained. External + access to web services/sites should not be needed. +* If the issue is needed for a hotfix release, add the 'expedite' label. +* Steps to reproduce the problem if possible. diff --git a/playbooks/roles/rsyslog_server/README.rst b/playbooks/roles/rsyslog_server/README.rst index b1c4928248..61c5dbed32 100644 --- a/playbooks/roles/rsyslog_server/README.rst +++ b/playbooks/roles/rsyslog_server/README.rst @@ -3,7 +3,8 @@ OpenStack rsyslog server :tags: openstack, rsyslog, server, cloud, ansible :category: \*nix -Role to deploy rsyslog for use within OpenStack when deploying services using containers. +Role to deploy rsyslog for use within OpenStack when deploying services using +containers. .. code-block:: yaml