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

Correct note syntax so Docker on non-Linux note shows up #26161

Merged
merged 1 commit into from
Jun 28, 2017
Merged

Correct note syntax so Docker on non-Linux note shows up #26161

merged 1 commit into from
Jun 28, 2017

Conversation

samdoran
Copy link
Contributor

SUMMARY

The note only had one colon instead of two, which allowed it to pass rstcheck but failed to actually generate the note in the HTML.

Also remove an unnecessary trailing colon.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

testing_integration.rst

ANSIBLE VERSION
ansible 2.4.0 (sdoran-test-docs-fix 1e623fdbb3) last updated 2017/06/27 16:59:58 (GMT -400)
  config file = /Users/sdoran/.ansible.cfg
  configured module search path = [u'/Users/sdoran/Source/ansible/library']
  ansible python module location = /Users/sdoran/Source/ansible/lib/ansible
  executable location = /Users/sdoran/Source/ansible/bin/ansible
  python version = 2.7.13 (default, Dec 18 2016, 07:03:39) [GCC 4.2.1 Compatible Apple LLVM 8.0.0 (clang-800.0.42.1)]
ADDITIONAL INFORMATION

None

@samdoran
Correct note syntax so Docker on non-Linux note shows up
1e623fd 
The note only had one colon instead of two, which allowed it to pass rstcheck but failed to actually generate the note in the HTML.

Also remove an unnecessary trailing colon.
@ansibot
Copy link
Contributor

ansibot commented Jun 27, 2017

cc @dharmabumstead
click here for bot help

@ansibot ansibot added affects_2.4 This issue/PR affects Ansible v2.4 docs_pull_request needs_triage Needs a first human triage before being processed. labels Jun 27, 2017
@gundalow gundalow merged commit 6f73ab8 into ansible:devel Jun 28, 2017
@gundalow
Copy link
Contributor

Ah, this is my fault, good spot.

Annoying that rstcheck didn't spot this.

Merging as it's a simple fix

@gundalow gundalow removed the needs_triage Needs a first human triage before being processed. label Jun 28, 2017
@samdoran
Copy link
Contributor Author

Really weird that rstcheck didn't catch it. I bet it's a big in their regexp. ¯_(ツ)_/¯

dharmabumstead
dharmabumstead reviewed Jun 29, 2017
View reviewed changes
docs/docsite/rst/dev_guide/testing_integration.rst

Using Docker Engine to run Docker on a non-Linux host is not recommended.
Using Docker Engine to run Docker on a non-Linux (such as macOS) host is not recommended.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revise to "Using Docker Engine to run Docker on a non-Linux host (such as macOS) is not recommended.

dharmabumstead added a commit that referenced this pull request Jun 29, 2017
@dharmabumstead
Editing to fix wording from PR #26161.
ed17d7a
@ansibot ansibot added docs This issue/PR relates to or includes documentation. and removed docs_pull_request labels Mar 4, 2018
@ansible ansible locked and limited conversation to collaborators Apr 26, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@dharmabumstead dharmabumstead dharmabumstead left review comments

@gundalow gundalow gundalow approved these changes

Assignees
No one assigned
Labels
affects_2.4 This issue/PR affects Ansible v2.4 docker docs This issue/PR relates to or includes documentation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@samdoran @ansibot @gundalow @dharmabumstead @dagwieers