From 33b9c880a42290b6db974d8a23677d07f6e22239 Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Tue, 15 Jan 2019 14:53:04 +0100 Subject: [PATCH] Consistent typesetting of "GitHub" (#50929) --- docs/docsite/rst/community/committer_guidelines.rst | 4 ++-- docs/docsite/rst/dev_guide/developing_api.rst | 2 +- .../rst/dev_guide/developing_modules_general_windows.rst | 2 +- docs/docsite/rst/dev_guide/testing.rst | 2 +- docs/docsite/rst/installation_guide/intro_configuration.rst | 2 +- docs/docsite/rst/installation_guide/intro_installation.rst | 2 +- docs/docsite/rst/reference_appendices/YAMLSyntax.rst | 2 +- docs/docsite/rst/reference_appendices/galaxy.rst | 2 +- docs/docsite/rst/user_guide/playbooks_intro.rst | 2 +- lib/ansible/cli/galaxy.py | 6 +++--- lib/ansible/galaxy/login.py | 6 +++--- lib/ansible/modules/source_control/_github_hooks.py | 2 +- lib/ansible/modules/source_control/github_webhook.py | 2 +- lib/ansible/modules/source_control/github_webhook_facts.py | 2 +- 14 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/docsite/rst/community/committer_guidelines.rst b/docs/docsite/rst/community/committer_guidelines.rst index 80257fd678c..ea71d7eb9c4 100644 --- a/docs/docsite/rst/community/committer_guidelines.rst +++ b/docs/docsite/rst/community/committer_guidelines.rst @@ -49,7 +49,7 @@ Individuals with direct commit access to ansible/ansible are entrusted with powe - 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. - 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. - Break playbooks. Always keep backwards compatibility in mind. - 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. +---------------------+----------------------+--------------------+----------------------+ -| Name | Github ID | IRC Nick | Other | +| Name | GitHub ID | IRC Nick | Other | +=====================+======================+====================+======================+ | James Cammarata | jimi-c | jimi | | +---------------------+----------------------+--------------------+----------------------+ diff --git a/docs/docsite/rst/dev_guide/developing_api.rst b/docs/docsite/rst/dev_guide/developing_api.rst index 40ce37cebea..3f06f8eba56 100644 --- a/docs/docsite/rst/dev_guide/developing_api.rst +++ b/docs/docsite/rst/dev_guide/developing_api.rst @@ -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. The source code for the ``ansible`` -command line tools (``lib/ansible/cli/``) is `available on Github `_. +command line tools (``lib/ansible/cli/``) is `available on GitHub `_. .. seealso:: diff --git a/docs/docsite/rst/dev_guide/developing_modules_general_windows.rst b/docs/docsite/rst/dev_guide/developing_modules_general_windows.rst index 5981fc05e4a..ac919ff4d6c 100644 --- a/docs/docsite/rst/dev_guide/developing_modules_general_windows.rst +++ b/docs/docsite/rst/dev_guide/developing_modules_general_windows.rst @@ -32,7 +32,7 @@ Vagrant Cloud. This guide will use the Vagrant boxes created by the `packer-windoze `_ repository which have also been uploaded to `Vagrant Cloud `_. -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. Before you can get started, the following programs must be installed (please consult the Vagrant and diff --git a/docs/docsite/rst/dev_guide/testing.rst b/docs/docsite/rst/dev_guide/testing.rst index 4b7f263e4b7..71b5bc8f3a2 100644 --- a/docs/docsite/rst/dev_guide/testing.rst +++ b/docs/docsite/rst/dev_guide/testing.rst @@ -45,7 +45,7 @@ development. 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 -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. diff --git a/docs/docsite/rst/installation_guide/intro_configuration.rst b/docs/docsite/rst/installation_guide/intro_configuration.rst index ef37ff5fffa..ef471016adb 100644 --- a/docs/docsite/rst/installation_guide/intro_configuration.rst +++ b/docs/docsite/rst/installation_guide/intro_configuration.rst @@ -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 default settings in Ansible. -An `example file is available on Github `_. +An `example file is available on GitHub `_. For more details and a full listing of available configurations go to :ref:`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. diff --git a/docs/docsite/rst/installation_guide/intro_installation.rst b/docs/docsite/rst/installation_guide/intro_installation.rst index 50693ffe781..9bb818e0bde 100644 --- a/docs/docsite/rst/installation_guide/intro_installation.rst +++ b/docs/docsite/rst/installation_guide/intro_installation.rst @@ -255,7 +255,7 @@ Ansible is available in the Community repository:: $ pacman -S ansible -The AUR has a PKGBUILD for pulling directly from Github called `ansible-git `_. +The AUR has a PKGBUILD for pulling directly from GitHub called `ansible-git `_. Also see the `Ansible `_ page on the ArchWiki. diff --git a/docs/docsite/rst/reference_appendices/YAMLSyntax.rst b/docs/docsite/rst/reference_appendices/YAMLSyntax.rst index 3e038777812..717ee7f3174 100644 --- a/docs/docsite/rst/reference_appendices/YAMLSyntax.rst +++ b/docs/docsite/rst/reference_appendices/YAMLSyntax.rst @@ -223,7 +223,7 @@ value:: Learn what playbooks can do and how to write/run them. `YAMLLint `_ YAML Lint (online) helps you debug YAML syntax if you are having problems - `Github examples directory `_ + `GitHub examples directory `_ Complete playbook files from the github project source `Wikipedia YAML syntax reference `_ A good guide to YAML syntax diff --git a/docs/docsite/rst/reference_appendices/galaxy.rst b/docs/docsite/rst/reference_appendices/galaxy.rst index 06ece7e567c..a55f0aea661 100644 --- a/docs/docsite/rst/reference_appendices/galaxy.rst +++ b/docs/docsite/rst/reference_appendices/galaxy.rst @@ -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. - Github Username: dsmith + GitHub Username: dsmith Password for dsmith: Successfully logged into Galaxy as dsmith diff --git a/docs/docsite/rst/user_guide/playbooks_intro.rst b/docs/docsite/rst/user_guide/playbooks_intro.rst index 818b9b7c994..dfab380ad8c 100644 --- a/docs/docsite/rst/user_guide/playbooks_intro.rst +++ b/docs/docsite/rst/user_guide/playbooks_intro.rst @@ -502,7 +502,7 @@ can do this:: Learn how to extend Ansible by writing your own modules :ref:`intro_patterns` Learn about how to select hosts - `Github examples directory `_ + `GitHub examples directory `_ Complete end-to-end playbook examples `Mailing List `_ Questions? Help? Ideas? Stop by the list on Google Groups diff --git a/lib/ansible/cli/galaxy.py b/lib/ansible/cli/galaxy.py index ca957bdce36..a93bc11abba 100644 --- a/lib/ansible/cli/galaxy.py +++ b/lib/ansible/cli/galaxy.py @@ -536,7 +536,7 @@ class GalaxyCLI(CLI): 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 if context.CLIARGS['token'] is None: @@ -588,7 +588,7 @@ class GalaxyCLI(CLI): if len(task) > 1: # 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') display.display("The following Galaxy roles are being updated:" + u'\n', color=C.COLOR_CHANGED) for t in task: @@ -620,7 +620,7 @@ class GalaxyCLI(CLI): return 0 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']: # List existing integration secrets diff --git a/lib/ansible/galaxy/login.py b/lib/ansible/galaxy/login.py index d8fc97cda39..dda85609916 100644 --- a/lib/ansible/galaxy/login.py +++ b/lib/ansible/galaxy/login.py @@ -50,7 +50,7 @@ class GalaxyLogin(object): self.get_credentials() 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) display.display("This information will " + stringc("not be sent to Galaxy", 'bright cyan') + ", 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) try: - self.github_username = input("Github Username: ") + self.github_username = input("GitHub Username: ") except Exception: pass @@ -69,7 +69,7 @@ class GalaxyLogin(object): pass 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): ''' diff --git a/lib/ansible/modules/source_control/_github_hooks.py b/lib/ansible/modules/source_control/_github_hooks.py index fd812f9b955..4116df87978 100644 --- a/lib/ansible/modules/source_control/_github_hooks.py +++ b/lib/ansible/modules/source_control/_github_hooks.py @@ -27,7 +27,7 @@ version_added: "1.4" options: user: description: - - Github username. + - GitHub username. required: true oauthkey: description: diff --git a/lib/ansible/modules/source_control/github_webhook.py b/lib/ansible/modules/source_control/github_webhook.py index f6a6df4a481..387abad897e 100644 --- a/lib/ansible/modules/source_control/github_webhook.py +++ b/lib/ansible/modules/source_control/github_webhook.py @@ -237,7 +237,7 @@ def main(): module.params["github_url"], to_native(err))) except github.UnknownObjectException as err: 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"], to_native(err))) except Exception as err: diff --git a/lib/ansible/modules/source_control/github_webhook_facts.py b/lib/ansible/modules/source_control/github_webhook_facts.py index 3a7a2711825..2afead90aff 100644 --- a/lib/ansible/modules/source_control/github_webhook_facts.py +++ b/lib/ansible/modules/source_control/github_webhook_facts.py @@ -144,7 +144,7 @@ def main(): module.params["github_url"], to_native(err))) except github.UnknownObjectException as err: 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"], to_native(err))) except Exception as err: