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.

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

Format fix on VMware Guide #41272

Merged
merged 4 commits into from
Jun 8, 2018
Merged

Format fix on VMware Guide #41272

merged 4 commits into from
Jun 8, 2018

Conversation

wazzaz
Copy link
Contributor

@wazzaz wazzaz commented Jun 7, 2018

SUMMARY

Minor formatting change on VMware Guide

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME
ANSIBLE VERSION

ADDITIONAL INFORMATION

@ansibot
Copy link
Contributor

ansibot commented Jun 7, 2018

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

docs/docsite/rst/scenario_guides/guide_vmware.rst:25:0: undefined-label: undefined label: vmware_guest (if the link has no caption the label must precede a section header)

click here for bot help

@ansibot ansibot added affects_2.7 This issue/PR affects Ansible v2.7 ci_verified Changes made in this PR are causing tests to fail. docs This issue/PR relates to or includes documentation. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. 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 Jun 7, 2018
@acozine
Copy link
Contributor

acozine commented Jun 7, 2018

@wazzaz, thanks for finding this issue in the docs, and for submitting a PR to fix it. The syntax for docs links is a bit finicky - it's :ref: followed by text of link<text_of_anchor> enclosed in backticks - so that line in the rST should read:

The :ref:`vmware_guest<vmware_guest_module>` module manages various operations related to virtual machines in the given ESXi or vCenter server.

You can test the link by running MODULES=vmware_guest make webdocs on your local machine.

In the example above, I've also revised the sentence so it doesn't use passive voice ("is used by").

Finally, it's preferable for a small change like this to be a single commit.

If you want practice at editing docs, squashing commits, opening/updating PRs, or other parts of the process, go ahead and fix this PR. Or, if you'd rather, I can pop that change on a branch and open a new PR. Your choice.

@acozine
Copy link
Contributor

acozine commented Jun 7, 2018

After you run MODULES=vmware_guest make webdocs, you can view the generated file on your laptop at file:///path/to/ansible/docs/docsite/_build/html/scenario_guides/guide_vmware.html and test the link out.

@samdoran samdoran removed the needs_triage Needs a first human triage before being processed. label Jun 7, 2018
@ansibot ansibot removed 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. labels Jun 8, 2018
@acozine acozine merged commit 91803c6 into ansible:devel Jun 8, 2018
@acozine acozine added this to To do in OLD Ansible Documentation via automation Jun 8, 2018
@acozine acozine moved this from To do to Backport to 2.5 in OLD Ansible Documentation Jun 8, 2018
@acozine acozine moved this from Backport to 2.5 to Backport to 2.6 in OLD Ansible Documentation Jun 8, 2018
@wazzaz wazzaz deleted the vmwaredocfix branch June 8, 2018 17:22
jacum pushed a commit to jacum/ansible that referenced this pull request Jun 26, 2018
* Updating format of VMware Guide: small formatting error - hyperlink to module
acozine pushed a commit to acozine/ansible that referenced this pull request Jun 28, 2018
* Updating format of VMware Guide: small formatting error - hyperlink to module
(cherry picked from commit 91803c6)
mattclay pushed a commit that referenced this pull request Jun 29, 2018
* Updating format of VMware Guide: small formatting error - hyperlink to module
(cherry picked from commit 91803c6)
kbreit pushed a commit to kbreit/ansible that referenced this pull request Jul 3, 2018
* Updating format of VMware Guide: small formatting error - hyperlink to module
(cherry picked from commit 91803c6)
@acozine acozine moved this from Backport to 2.6 to Done in OLD Ansible Documentation Jul 6, 2018
@dagwieers dagwieers added the vmware VMware community label Feb 10, 2019
@ansible ansible locked and limited conversation to collaborators Jun 11, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.7 This issue/PR affects Ansible v2.7 cloud 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. vmware VMware community
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

5 participants