Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update macOS installation instructions #67058

Merged
merged 5 commits into from Feb 12, 2020
Merged

Update macOS installation instructions #67058

merged 5 commits into from Feb 12, 2020

Conversation

noncreature0714
Copy link
Contributor

SUMMARY

On macOS Catalina pip install --user ansible results in warnings and errors. There are quite a few bad or very unsafe answers out there, and this updates the reference documents to reflect changes Catalina+ with a safe, easy install for Ansible.

WARNING: pip is being invoked by an old script wrapper. This will fail in a future version of pip.
WARNING: pip is configured with locations that require TLS/SSL, however the ssl module in Python is not available.
WARNING: Retrying (Retry(total=4, connect=None, read=None, redirect=None, status=None)) after connection broken by 'SSLError("Can't connect to HTTPS URL because the SSL module is not available.")': /simple/ansible/
.... (previous warning repeated)
ERROR: Could not find a version that satisfies the requirement ansible (from versions: none)
ERROR: No matching distribution found for ansible
WARNING: pip is configured with locations that require TLS/SSL, however the ssl module in Python is not available.

Therefore, it's bests to access pip as a module and run:

python -m pip install --user ansible

And so forth.

ISSUE TYPE
  • Docs Pull Request

+label: docsite_pr

SUMMARY
ISSUE TYPE
  • Bugfix Pull Request
  • Docs Pull Request
  • Feature Pull Request
  • New Module Pull Request
COMPONENT NAME
ADDITIONAL INFORMATION

@noncreature0714
Update macOS installation instructions
572c2d8 
##### SUMMARY
<!--- Your description here -->

On macOS Catalina ``pip install --user ansible`` results in warnings and errors. There are quite a [few bad or very unsafe answers]( https://stackoverflow.com/questions/45954528/pip-is-configured-with-locations-that-require-tls-ssl-however-the-ssl-module-in/59280089#59280089) out there, and this updates the reference documents to reflect changes Catalina+ with a safe, easy install for Ansible.

    WARNING: pip is being invoked by an old script wrapper. This will fail in a future version of pip.
    WARNING: pip is configured with locations that require TLS/SSL, however the ssl module in Python is not available.
    WARNING: Retrying (Retry(total=4, connect=None, read=None, redirect=None, status=None)) after connection broken by 'SSLError("Can't connect to HTTPS URL because the SSL module is not available.")': /simple/ansible/
    .... (previous warning repeated)
    ERROR: Could not find a version that satisfies the requirement ansible (from versions: none)
    ERROR: No matching distribution found for ansible
    WARNING: pip is configured with locations that require TLS/SSL, however the ssl module in Python is not available.

Therefore, it's bests to access pip as a module and run: 

    python -m pip install --user ansible

And so forth.

##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
@ansibot
Copy link
Contributor

ansibot commented Feb 3, 2020

cc @acozine
click here for bot help

@ansibot ansibot added affects_2.10 This issue/PR affects Ansible v2.10 core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. needs_triage Needs a first human triage before being processed. new_contributor This PR is the first contribution by a new community member. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Feb 3, 2020
@ansibot
Copy link
Contributor

ansibot commented Feb 3, 2020

The test ansible-test sanity --test docs-build [explain] failed with 1 error:

docs/docsite/rst/installation_guide/intro_installation.rst:302:0: warning: Inline emphasis start-string without end-string.

click here for bot help

@ansibot ansibot added ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed core_review In order to be merged, this PR must follow the core review workflow. labels Feb 3, 2020
@noncreature0714
Copy link
Contributor Author

What do I need to change to pass tests? I'm guessing a markdown linter is complaining.

@ansibot ansibot removed the needs_triage Needs a first human triage before being processed. label Feb 4, 2020
@acozine
Copy link
Contributor

acozine commented Feb 11, 2020

@noncreature0714 thanks for your interest in the Ansible docs!

Because the * character is used to mark bold text, Sphinx reads "*nix" as the start of a section that should be bolded. It's throwing an error because there's no closing *. If you accept @samdoran's suggestions, this error should go away.

@ansibot ansibot added the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label Feb 11, 2020
@noncreature0714
Copy link
Contributor Author

@acozine @samdoran Thank you for suggestions and help! I've not been able to get back to this as quick as I'd like, but will promptly make the changes :)

noncreature0714 and others added 4 commits February 11, 2020 15:58
@noncreature0714 @samdoran
Update docs/docsite/rst/installation_guide/intro_installation.rst
69ba274 
Co-Authored-By: Sam Doran <sdoran@redhat.com>
@noncreature0714 @samdoran
Update docs/docsite/rst/installation_guide/intro_installation.rst
09568dc 
Co-Authored-By: Sam Doran <sdoran@redhat.com>
@noncreature0714 @samdoran
Update docs/docsite/rst/installation_guide/intro_installation.rst
20c77f6 
Co-Authored-By: Sam Doran <sdoran@redhat.com>
@noncreature0714 @samdoran
Update docs/docsite/rst/installation_guide/intro_installation.rst
ed010c9 
Co-Authored-By: Sam Doran <sdoran@redhat.com>
@ansibot ansibot added core_review In order to be merged, this PR must follow the core review workflow. and removed ci_verified Changes made in this PR are causing tests to fail. stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Feb 11, 2020
@acozine
Copy link
Contributor

acozine commented Feb 12, 2020

Thanks @noncreature0714 for updating the PR. We may have additional changes to this page in the next few weeks, keep an eye on open PRs with the label docs if you want to chime in!

@acozine acozine merged commit 561f8c1 into ansible:devel Feb 12, 2020
@noncreature0714
Copy link
Contributor Author

noncreature0714 commented Feb 13, 2020 via email

@ansible ansible locked and limited conversation to collaborators Mar 11, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@samdoran samdoran samdoran left review comments

Assignees
No one assigned
Labels
affects_2.10 This issue/PR affects Ansible v2.10 core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. new_contributor This PR is the first contribution by a new community member. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@noncreature0714 @ansibot @acozine @samdoran