Cleaning up doc8 violations.
Change-Id: I6c3f2827ae077d962bc7e8c7a9c0a5e5faa6aac8
This commit is contained in:
Justin Shepherd
Kevin Carter
parent
973a28ef11
commit
47c84afe19
@ -9,43 +9,55 @@ contributor guidelines
|
|||||||
Filing Bugs
|
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:
|
When submitting a bug, or working on a bug, please ensure the following
|
||||||
* The description clearly states or describes the original problem or root cause of the problem.
|
criteria are met:
|
||||||
* Include historical information on how the problem was identified.
|
|
||||||
* Any relevant logs are included.
|
* The description clearly states or describes the original problem or root
|
||||||
* The provided information should be totally self-contained. External access to web services/sites should not be needed.
|
cause of the problem.
|
||||||
* Steps to reproduce the problem if possible.
|
* 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
|
Submitting Code
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
Changes to the project should be submitted for review via the Gerrit tool, following
|
Changes to the project should be submitted for review via the Gerrit tool,
|
||||||
the workflow documented at: "http://docs.openstack.org/infra/manual/developers.html#development-workflow"
|
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
|
Extra
|
||||||
-----
|
-----
|
||||||
|
|
||||||
Tags:
|
Tags:
|
||||||
If it's a bug that needs fixing in a branch in addition to Master, add a '\<release\>-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
|
||||||
|
'\<release\>-backport-potential' tag (eg ``juno-backport-potential``).
|
||||||
|
There are predefined tags that will autocomplete.
|
||||||
|
|
||||||
Status:
|
Status:
|
||||||
Please leave this alone, it should be New till someone triages the issue.
|
Please leave this alone, it should be New till someone triages the issue.
|
||||||
|
|
||||||
Importance:
|
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
|
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:
|
Example YAML dictionary format:
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
@ -69,17 +81,23 @@ Example **NOT** in YAML dictionary format:
|
|||||||
- some-other-tag
|
- 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
|
Issues
|
||||||
------
|
------
|
||||||
|
|
||||||
When submitting an issue, or working on an issue please ensure the following criteria are met:
|
When submitting an issue, or working on an issue please ensure the following
|
||||||
* The description clearly states or describes the original problem or root cause of the problem.
|
criteria are met:
|
||||||
* Include historical information on how the problem was identified.
|
|
||||||
* Any relevant logs are included.
|
* The description clearly states or describes the original problem or root
|
||||||
* 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).
|
cause of the problem.
|
||||||
* The provided information should be totally self-contained. External access to web services/sites should not be needed.
|
* Include historical information on how the problem was identified.
|
||||||
* If the issue is needed for a hotfix release, add the 'expedite' label.
|
* Any relevant logs are included.
|
||||||
* Steps to reproduce the problem if possible.
|
* 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.
|
||||||
|
|||||||
@ -9,43 +9,55 @@ contributor guidelines
|
|||||||
Filing Bugs
|
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:
|
When submitting a bug, or working on a bug, please ensure the following
|
||||||
* The description clearly states or describes the original problem or root cause of the problem.
|
criteria are met:
|
||||||
* Include historical information on how the problem was identified.
|
|
||||||
* Any relevant logs are included.
|
* The description clearly states or describes the original problem or root
|
||||||
* The provided information should be totally self-contained. External access to web services/sites should not be needed.
|
cause of the problem.
|
||||||
* Steps to reproduce the problem if possible.
|
* 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
|
Submitting Code
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
Changes to the project should be submitted for review via the Gerrit tool, following
|
Changes to the project should be submitted for review via the Gerrit tool,
|
||||||
the workflow documented at: "http://docs.openstack.org/infra/manual/developers.html#development-workflow"
|
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
|
Extra
|
||||||
-----
|
-----
|
||||||
|
|
||||||
Tags:
|
Tags:
|
||||||
If it's a bug that needs fixing in a branch in addition to Master, add a '\<release\>-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
|
||||||
|
'\<release\>-backport-potential' tag (eg ``juno-backport-potential``).
|
||||||
|
There are predefined tags that will autocomplete.
|
||||||
|
|
||||||
Status:
|
Status:
|
||||||
Please leave this alone, it should be New till someone triages the issue.
|
Please leave this alone, it should be New till someone triages the issue.
|
||||||
|
|
||||||
Importance:
|
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
|
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:
|
Example YAML dictionary format:
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
@ -69,17 +81,23 @@ Example **NOT** in YAML dictionary format:
|
|||||||
- some-other-tag
|
- 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
|
Issues
|
||||||
------
|
------
|
||||||
|
|
||||||
When submitting an issue, or working on an issue please ensure the following criteria are met:
|
When submitting an issue, or working on an issue please ensure the following
|
||||||
* The description clearly states or describes the original problem or root cause of the problem.
|
criteria are met:
|
||||||
* Include historical information on how the problem was identified.
|
|
||||||
* Any relevant logs are included.
|
* The description clearly states or describes the original problem or root
|
||||||
* 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).
|
cause of the problem.
|
||||||
* The provided information should be totally self-contained. External access to web services/sites should not be needed.
|
* Include historical information on how the problem was identified.
|
||||||
* If the issue is needed for a hotfix release, add the 'expedite' label.
|
* Any relevant logs are included.
|
||||||
* Steps to reproduce the problem if possible.
|
* 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.
|
||||||
|
|||||||
@ -3,7 +3,9 @@ OpenStack pip lockdown
|
|||||||
:tags: openstack, pip, lockdown, cloud, ansible
|
:tags: openstack, pip, lockdown, cloud, ansible
|
||||||
:category: \*nix
|
:category: \*nix
|
||||||
|
|
||||||
Role to lock pip down to a particular links repo. This will create a ``.pip.conf`` which will ensure that the only python packages installed when using pip are from a known repository of packages.
|
Role to lock pip down to a particular links repo. This will create a
|
||||||
|
``.pip.conf`` which will ensure that the only python packages installed when
|
||||||
|
using pip are from a known repository of packages.
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
|||||||
@ -9,43 +9,55 @@ contributor guidelines
|
|||||||
Filing Bugs
|
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:
|
When submitting a bug, or working on a bug, please ensure the following
|
||||||
* The description clearly states or describes the original problem or root cause of the problem.
|
criteria are met:
|
||||||
* Include historical information on how the problem was identified.
|
|
||||||
* Any relevant logs are included.
|
* The description clearly states or describes the original problem or root
|
||||||
* The provided information should be totally self-contained. External access to web services/sites should not be needed.
|
cause of the problem.
|
||||||
* Steps to reproduce the problem if possible.
|
* 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
|
Submitting Code
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
Changes to the project should be submitted for review via the Gerrit tool, following
|
Changes to the project should be submitted for review via the Gerrit tool,
|
||||||
the workflow documented at: "http://docs.openstack.org/infra/manual/developers.html#development-workflow"
|
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
|
Extra
|
||||||
-----
|
-----
|
||||||
|
|
||||||
Tags:
|
Tags:
|
||||||
If it's a bug that needs fixing in a branch in addition to Master, add a '\<release\>-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
|
||||||
|
'\<release\>-backport-potential' tag (eg ``juno-backport-potential``).
|
||||||
|
There are predefined tags that will autocomplete.
|
||||||
|
|
||||||
Status:
|
Status:
|
||||||
Please leave this alone, it should be New till someone triages the issue.
|
Please leave this alone, it should be New till someone triages the issue.
|
||||||
|
|
||||||
Importance:
|
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
|
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:
|
Example YAML dictionary format:
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
@ -69,17 +81,23 @@ Example **NOT** in YAML dictionary format:
|
|||||||
- some-other-tag
|
- 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
|
Issues
|
||||||
------
|
------
|
||||||
|
|
||||||
When submitting an issue, or working on an issue please ensure the following criteria are met:
|
When submitting an issue, or working on an issue please ensure the following
|
||||||
* The description clearly states or describes the original problem or root cause of the problem.
|
criteria are met:
|
||||||
* Include historical information on how the problem was identified.
|
|
||||||
* Any relevant logs are included.
|
* The description clearly states or describes the original problem or root
|
||||||
* 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).
|
cause of the problem.
|
||||||
* The provided information should be totally self-contained. External access to web services/sites should not be needed.
|
* Include historical information on how the problem was identified.
|
||||||
* If the issue is needed for a hotfix release, add the 'expedite' label.
|
* Any relevant logs are included.
|
||||||
* Steps to reproduce the problem if possible.
|
* 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.
|
||||||
|
|||||||
@ -9,43 +9,55 @@ contributor guidelines
|
|||||||
Filing Bugs
|
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:
|
When submitting a bug, or working on a bug, please ensure the following
|
||||||
* The description clearly states or describes the original problem or root cause of the problem.
|
criteria are met:
|
||||||
* Include historical information on how the problem was identified.
|
|
||||||
* Any relevant logs are included.
|
* The description clearly states or describes the original problem or root
|
||||||
* The provided information should be totally self-contained. External access to web services/sites should not be needed.
|
cause of the problem.
|
||||||
* Steps to reproduce the problem if possible.
|
* 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
|
Submitting Code
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
Changes to the project should be submitted for review via the Gerrit tool, following
|
Changes to the project should be submitted for review via the Gerrit tool,
|
||||||
the workflow documented at: "http://docs.openstack.org/infra/manual/developers.html#development-workflow"
|
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
|
Extra
|
||||||
-----
|
-----
|
||||||
|
|
||||||
Tags:
|
Tags:
|
||||||
If it's a bug that needs fixing in a branch in addition to Master, add a '\<release\>-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
|
||||||
|
'\<release\>-backport-potential' tag (eg ``juno-backport-potential``).
|
||||||
|
There are predefined tags that will autocomplete.
|
||||||
|
|
||||||
Status:
|
Status:
|
||||||
Please leave this alone, it should be New till someone triages the issue.
|
Please leave this alone, it should be New till someone triages the issue.
|
||||||
|
|
||||||
Importance:
|
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
|
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:
|
Example YAML dictionary format:
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
@ -69,17 +81,23 @@ Example **NOT** in YAML dictionary format:
|
|||||||
- some-other-tag
|
- 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
|
Issues
|
||||||
------
|
------
|
||||||
|
|
||||||
When submitting an issue, or working on an issue please ensure the following criteria are met:
|
When submitting an issue, or working on an issue please ensure the following
|
||||||
* The description clearly states or describes the original problem or root cause of the problem.
|
criteria are met:
|
||||||
* Include historical information on how the problem was identified.
|
|
||||||
* Any relevant logs are included.
|
* The description clearly states or describes the original problem or root
|
||||||
* 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).
|
cause of the problem.
|
||||||
* The provided information should be totally self-contained. External access to web services/sites should not be needed.
|
* Include historical information on how the problem was identified.
|
||||||
* If the issue is needed for a hotfix release, add the 'expedite' label.
|
* Any relevant logs are included.
|
||||||
* Steps to reproduce the problem if possible.
|
* 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.
|
||||||
|
|||||||
@ -12,40 +12,51 @@ 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:
|
When submitting a bug, or working on a bug, please ensure the following
|
||||||
* The description clearly states or describes the original problem or root cause of the problem.
|
criteria are met:
|
||||||
* Include historical information on how the problem was identified.
|
|
||||||
* Any relevant logs are included.
|
* The description clearly states or describes the original problem or root
|
||||||
* The provided information should be totally self-contained. External access to web services/sites should not be needed.
|
cause of the problem.
|
||||||
* Steps to reproduce the problem if possible.
|
* 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
|
Submitting Code
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
Changes to the project should be submitted for review via the Gerrit tool, following
|
Changes to the project should be submitted for review via the Gerrit tool,
|
||||||
the workflow documented at: "http://docs.openstack.org/infra/manual/developers.html#development-workflow"
|
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
|
Extra
|
||||||
-----
|
-----
|
||||||
|
|
||||||
Tags:
|
Tags:
|
||||||
If it's a bug that needs fixing in a branch in addition to Master, add a '\<release\>-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
|
||||||
|
'\<release\>-backport-potential' tag (eg ``juno-backport-potential``).
|
||||||
|
There are predefined tags that will autocomplete.
|
||||||
|
|
||||||
Status:
|
Status:
|
||||||
Please leave this alone, it should be New till someone triages the issue.
|
Please leave this alone, it should be New till someone triages the issue.
|
||||||
|
|
||||||
Importance:
|
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
|
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:
|
Example YAML dictionary format:
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
@ -69,17 +80,23 @@ Example **NOT** in YAML dictionary format:
|
|||||||
- some-other-tag
|
- 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
|
Issues
|
||||||
------
|
------
|
||||||
|
|
||||||
When submitting an issue, or working on an issue please ensure the following criteria are met:
|
When submitting an issue, or working on an issue please ensure the following
|
||||||
* The description clearly states or describes the original problem or root cause of the problem.
|
criteria are met:
|
||||||
* Include historical information on how the problem was identified.
|
|
||||||
* Any relevant logs are included.
|
* The description clearly states or describes the original problem or root
|
||||||
* 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).
|
cause of the problem.
|
||||||
* The provided information should be totally self-contained. External access to web services/sites should not be needed.
|
* Include historical information on how the problem was identified.
|
||||||
* If the issue is needed for a hotfix release, add the 'expedite' label.
|
* Any relevant logs are included.
|
||||||
* Steps to reproduce the problem if possible.
|
* 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.
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user