Consistent typesetting of "GitHub" (#50929)
This commit is contained in:
parent
e515b4000c
commit
33b9c880a4
14 changed files with 19 additions and 19 deletions
|
@ -49,7 +49,7 @@ Individuals with direct commit access to ansible/ansible are entrusted with powe
|
||||||
- Commit directly.
|
- Commit directly.
|
||||||
- Merge your own PRs. Someone else should have a chance to review and approve the PR merge. If you are a Core Committer, you have a small amount of leeway here for very minor changes.
|
- Merge your own PRs. Someone else should have a chance to review and approve the PR merge. If you are a Core Committer, you have a small amount of leeway here for very minor changes.
|
||||||
- Forget about alternate environments. Consider the alternatives--yes, people have bad environments, but they are the ones who need us the most.
|
- Forget about alternate environments. Consider the alternatives--yes, people have bad environments, but they are the ones who need us the most.
|
||||||
- Drag your community team members down. Always discuss the technical merits, but you should never address the person's limitations (you can later go for beers and call them idiots, but not in IRC/Github/etc.).
|
- Drag your community team members down. Always discuss the technical merits, but you should never address the person's limitations (you can later go for beers and call them idiots, but not in IRC/GitHub/etc.).
|
||||||
- Forget about the maintenance burden. Some things are really cool to have, but they might not be worth shoehorning in if the maintenance burden is too great.
|
- Forget about the maintenance burden. Some things are really cool to have, but they might not be worth shoehorning in if the maintenance burden is too great.
|
||||||
- Break playbooks. Always keep backwards compatibility in mind.
|
- Break playbooks. Always keep backwards compatibility in mind.
|
||||||
- Forget to keep it simple. Complexity breeds all kinds of problems.
|
- Forget to keep it simple. Complexity breeds all kinds of problems.
|
||||||
|
@ -74,7 +74,7 @@ People
|
||||||
Individuals who've been asked to become a part of this group have generally been contributing in significant ways to the Ansible community for some time. Should they agree, they are requested to add their names and GitHub IDs to this file, in the section below, via a pull request. Doing so indicates that these individuals agree to act in the ways that their fellow committers trust that they will act.
|
Individuals who've been asked to become a part of this group have generally been contributing in significant ways to the Ansible community for some time. Should they agree, they are requested to add their names and GitHub IDs to this file, in the section below, via a pull request. Doing so indicates that these individuals agree to act in the ways that their fellow committers trust that they will act.
|
||||||
|
|
||||||
+---------------------+----------------------+--------------------+----------------------+
|
+---------------------+----------------------+--------------------+----------------------+
|
||||||
| Name | Github ID | IRC Nick | Other |
|
| Name | GitHub ID | IRC Nick | Other |
|
||||||
+=====================+======================+====================+======================+
|
+=====================+======================+====================+======================+
|
||||||
| James Cammarata | jimi-c | jimi | |
|
| James Cammarata | jimi-c | jimi | |
|
||||||
+---------------------+----------------------+--------------------+----------------------+
|
+---------------------+----------------------+--------------------+----------------------+
|
||||||
|
|
|
@ -109,7 +109,7 @@ This example is a simple demonstration that shows how to minimally run a couple
|
||||||
.. note:: Ansible emits warnings and errors via the display object, which prints directly to stdout, stderr and the Ansible log.
|
.. note:: Ansible emits warnings and errors via the display object, which prints directly to stdout, stderr and the Ansible log.
|
||||||
|
|
||||||
The source code for the ``ansible``
|
The source code for the ``ansible``
|
||||||
command line tools (``lib/ansible/cli/``) is `available on Github <https://github.com/ansible/ansible/tree/devel/lib/ansible/cli>`_.
|
command line tools (``lib/ansible/cli/``) is `available on GitHub <https://github.com/ansible/ansible/tree/devel/lib/ansible/cli>`_.
|
||||||
|
|
||||||
.. seealso::
|
.. seealso::
|
||||||
|
|
||||||
|
|
|
@ -32,7 +32,7 @@ Vagrant Cloud.
|
||||||
|
|
||||||
This guide will use the Vagrant boxes created by the `packer-windoze <https://github.com/jborean93/packer-windoze>`_
|
This guide will use the Vagrant boxes created by the `packer-windoze <https://github.com/jborean93/packer-windoze>`_
|
||||||
repository which have also been uploaded to `Vagrant Cloud <https://app.vagrantup.com/boxes/search?utf8=%E2%9C%93&sort=downloads&provider=&q=jborean93>`_.
|
repository which have also been uploaded to `Vagrant Cloud <https://app.vagrantup.com/boxes/search?utf8=%E2%9C%93&sort=downloads&provider=&q=jborean93>`_.
|
||||||
To find out more info on how these images are created, please go to the Github
|
To find out more info on how these images are created, please go to the GitHub
|
||||||
repo and look at the ``README`` file.
|
repo and look at the ``README`` file.
|
||||||
|
|
||||||
Before you can get started, the following programs must be installed (please consult the Vagrant and
|
Before you can get started, the following programs must be installed (please consult the Vagrant and
|
||||||
|
|
|
@ -45,7 +45,7 @@ development.
|
||||||
|
|
||||||
Even for non developers, helping to test pull requests for bug fixes and features is still
|
Even for non developers, helping to test pull requests for bug fixes and features is still
|
||||||
immensely valuable. Ansible users who understand writing playbooks and roles should be
|
immensely valuable. Ansible users who understand writing playbooks and roles should be
|
||||||
able to add integration tests and so Github pull requests with integration tests that show
|
able to add integration tests and so GitHub pull requests with integration tests that show
|
||||||
bugs in action will also be a great way to help.
|
bugs in action will also be a great way to help.
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -30,7 +30,7 @@ as a ``.rpmnew`` file (or other) as appropriate in the case of updates.
|
||||||
If you installed Ansible from pip or from source, you may want to create this file in order to override
|
If you installed Ansible from pip or from source, you may want to create this file in order to override
|
||||||
default settings in Ansible.
|
default settings in Ansible.
|
||||||
|
|
||||||
An `example file is available on Github <https://raw.githubusercontent.com/ansible/ansible/devel/examples/ansible.cfg>`_.
|
An `example file is available on GitHub <https://raw.githubusercontent.com/ansible/ansible/devel/examples/ansible.cfg>`_.
|
||||||
|
|
||||||
For more details and a full listing of available configurations go to :ref:`configuration_settings<ansible_configuration_settings>`. Starting with Ansible version 2.4, you can use the :ref:`ansible-config` command line utility to list your available options and inspect the current values.
|
For more details and a full listing of available configurations go to :ref:`configuration_settings<ansible_configuration_settings>`. Starting with Ansible version 2.4, you can use the :ref:`ansible-config` command line utility to list your available options and inspect the current values.
|
||||||
|
|
||||||
|
|
|
@ -255,7 +255,7 @@ Ansible is available in the Community repository::
|
||||||
|
|
||||||
$ pacman -S ansible
|
$ pacman -S ansible
|
||||||
|
|
||||||
The AUR has a PKGBUILD for pulling directly from Github called `ansible-git <https://aur.archlinux.org/packages/ansible-git>`_.
|
The AUR has a PKGBUILD for pulling directly from GitHub called `ansible-git <https://aur.archlinux.org/packages/ansible-git>`_.
|
||||||
|
|
||||||
Also see the `Ansible <https://wiki.archlinux.org/index.php/Ansible>`_ page on the ArchWiki.
|
Also see the `Ansible <https://wiki.archlinux.org/index.php/Ansible>`_ page on the ArchWiki.
|
||||||
|
|
||||||
|
|
|
@ -223,7 +223,7 @@ value::
|
||||||
Learn what playbooks can do and how to write/run them.
|
Learn what playbooks can do and how to write/run them.
|
||||||
`YAMLLint <http://yamllint.com/>`_
|
`YAMLLint <http://yamllint.com/>`_
|
||||||
YAML Lint (online) helps you debug YAML syntax if you are having problems
|
YAML Lint (online) helps you debug YAML syntax if you are having problems
|
||||||
`Github examples directory <https://github.com/ansible/ansible-examples>`_
|
`GitHub examples directory <https://github.com/ansible/ansible-examples>`_
|
||||||
Complete playbook files from the github project source
|
Complete playbook files from the github project source
|
||||||
`Wikipedia YAML syntax reference <https://en.wikipedia.org/wiki/YAML>`_
|
`Wikipedia YAML syntax reference <https://en.wikipedia.org/wiki/YAML>`_
|
||||||
A good guide to YAML syntax
|
A good guide to YAML syntax
|
||||||
|
|
|
@ -382,7 +382,7 @@ The following shows authenticating with the Galaxy website using a GitHub userna
|
||||||
|
|
||||||
Use --github-token if you do not want to enter your password.
|
Use --github-token if you do not want to enter your password.
|
||||||
|
|
||||||
Github Username: dsmith
|
GitHub Username: dsmith
|
||||||
Password for dsmith:
|
Password for dsmith:
|
||||||
Successfully logged into Galaxy as dsmith
|
Successfully logged into Galaxy as dsmith
|
||||||
|
|
||||||
|
|
|
@ -502,7 +502,7 @@ can do this::
|
||||||
Learn how to extend Ansible by writing your own modules
|
Learn how to extend Ansible by writing your own modules
|
||||||
:ref:`intro_patterns`
|
:ref:`intro_patterns`
|
||||||
Learn about how to select hosts
|
Learn about how to select hosts
|
||||||
`Github examples directory <https://github.com/ansible/ansible-examples>`_
|
`GitHub examples directory <https://github.com/ansible/ansible-examples>`_
|
||||||
Complete end-to-end playbook examples
|
Complete end-to-end playbook examples
|
||||||
`Mailing List <https://groups.google.com/group/ansible-project>`_
|
`Mailing List <https://groups.google.com/group/ansible-project>`_
|
||||||
Questions? Help? Ideas? Stop by the list on Google Groups
|
Questions? Help? Ideas? Stop by the list on Google Groups
|
||||||
|
|
|
@ -536,7 +536,7 @@ class GalaxyCLI(CLI):
|
||||||
|
|
||||||
def execute_login(self):
|
def execute_login(self):
|
||||||
"""
|
"""
|
||||||
verify user's identify via Github and retrieve an auth token from Ansible Galaxy.
|
verify user's identify via GitHub and retrieve an auth token from Ansible Galaxy.
|
||||||
"""
|
"""
|
||||||
# Authenticate with github and retrieve a token
|
# Authenticate with github and retrieve a token
|
||||||
if context.CLIARGS['token'] is None:
|
if context.CLIARGS['token'] is None:
|
||||||
|
@ -588,7 +588,7 @@ class GalaxyCLI(CLI):
|
||||||
|
|
||||||
if len(task) > 1:
|
if len(task) > 1:
|
||||||
# found multiple roles associated with github_user/github_repo
|
# found multiple roles associated with github_user/github_repo
|
||||||
display.display("WARNING: More than one Galaxy role associated with Github repo %s/%s." % (github_user, github_repo),
|
display.display("WARNING: More than one Galaxy role associated with GitHub repo %s/%s." % (github_user, github_repo),
|
||||||
color='yellow')
|
color='yellow')
|
||||||
display.display("The following Galaxy roles are being updated:" + u'\n', color=C.COLOR_CHANGED)
|
display.display("The following Galaxy roles are being updated:" + u'\n', color=C.COLOR_CHANGED)
|
||||||
for t in task:
|
for t in task:
|
||||||
|
@ -620,7 +620,7 @@ class GalaxyCLI(CLI):
|
||||||
return 0
|
return 0
|
||||||
|
|
||||||
def execute_setup(self):
|
def execute_setup(self):
|
||||||
""" Setup an integration from Github or Travis for Ansible Galaxy roles"""
|
""" Setup an integration from GitHub or Travis for Ansible Galaxy roles"""
|
||||||
|
|
||||||
if context.CLIARGS['setup_list']:
|
if context.CLIARGS['setup_list']:
|
||||||
# List existing integration secrets
|
# List existing integration secrets
|
||||||
|
|
|
@ -50,7 +50,7 @@ class GalaxyLogin(object):
|
||||||
self.get_credentials()
|
self.get_credentials()
|
||||||
|
|
||||||
def get_credentials(self):
|
def get_credentials(self):
|
||||||
display.display(u'\n\n' + "We need your " + stringc("Github login", 'bright cyan') +
|
display.display(u'\n\n' + "We need your " + stringc("GitHub login", 'bright cyan') +
|
||||||
" to identify you.", screen_only=True)
|
" to identify you.", screen_only=True)
|
||||||
display.display("This information will " + stringc("not be sent to Galaxy", 'bright cyan') +
|
display.display("This information will " + stringc("not be sent to Galaxy", 'bright cyan') +
|
||||||
", only to " + stringc("api.github.com.", "yellow"), screen_only=True)
|
", only to " + stringc("api.github.com.", "yellow"), screen_only=True)
|
||||||
|
@ -59,7 +59,7 @@ class GalaxyLogin(object):
|
||||||
" if you do not want to enter your password." + u'\n\n', screen_only=True)
|
" if you do not want to enter your password." + u'\n\n', screen_only=True)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
self.github_username = input("Github Username: ")
|
self.github_username = input("GitHub Username: ")
|
||||||
except Exception:
|
except Exception:
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
@ -69,7 +69,7 @@ class GalaxyLogin(object):
|
||||||
pass
|
pass
|
||||||
|
|
||||||
if not self.github_username or not self.github_password:
|
if not self.github_username or not self.github_password:
|
||||||
raise AnsibleError("Invalid Github credentials. Username and password are required.")
|
raise AnsibleError("Invalid GitHub credentials. Username and password are required.")
|
||||||
|
|
||||||
def remove_github_token(self):
|
def remove_github_token(self):
|
||||||
'''
|
'''
|
||||||
|
|
|
@ -27,7 +27,7 @@ version_added: "1.4"
|
||||||
options:
|
options:
|
||||||
user:
|
user:
|
||||||
description:
|
description:
|
||||||
- Github username.
|
- GitHub username.
|
||||||
required: true
|
required: true
|
||||||
oauthkey:
|
oauthkey:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -237,7 +237,7 @@ def main():
|
||||||
module.params["github_url"], to_native(err)))
|
module.params["github_url"], to_native(err)))
|
||||||
except github.UnknownObjectException as err:
|
except github.UnknownObjectException as err:
|
||||||
module.fail_json(
|
module.fail_json(
|
||||||
msg="Could not find repository %s in Github at %s: %s" % (
|
msg="Could not find repository %s in GitHub at %s: %s" % (
|
||||||
module.params["repository"], module.params["github_url"],
|
module.params["repository"], module.params["github_url"],
|
||||||
to_native(err)))
|
to_native(err)))
|
||||||
except Exception as err:
|
except Exception as err:
|
||||||
|
|
|
@ -144,7 +144,7 @@ def main():
|
||||||
module.params["github_url"], to_native(err)))
|
module.params["github_url"], to_native(err)))
|
||||||
except github.UnknownObjectException as err:
|
except github.UnknownObjectException as err:
|
||||||
module.fail_json(
|
module.fail_json(
|
||||||
msg="Could not find repository %s in Github at %s: %s" % (
|
msg="Could not find repository %s in GitHub at %s: %s" % (
|
||||||
module.params["repository"], module.params["github_url"],
|
module.params["repository"], module.params["github_url"],
|
||||||
to_native(err)))
|
to_native(err)))
|
||||||
except Exception as err:
|
except Exception as err:
|
||||||
|
|
Loading…
Reference in a new issue