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

Extends 'which notation should I use' section in FAQ #43729

Conversation

ctorgalson
Copy link
Contributor

SUMMARY

Expands documentation of "Which notation should I use?" in FAQ section.

See comment in #11524.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

Docs.

ANSIBLE VERSION
  config file = /etc/ansible/ansible.cfg
  configured module search path = [u'/Users/ctorgalson/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/local/lib/python2.7/site-packages/ansible
  executable location = /usr/local/bin/ansible
  python version = 2.7.15 (default, Jul 23 2018, 21:27:06) [GCC 4.2.1 Compatible Apple LLVM 9.1.0 (clang-902.0.39.2)]
ADDITIONAL INFORMATION

I'm not sure what the docs use to process RST, so I have not used a named anchor in the PR to link to the specific section. I can update the PR if anyone can enlighten me on the right format for relative link to a named anchor in the docs.

@ansibot
Copy link
Contributor

ansibot commented Aug 6, 2018

@ansibot ansibot added affects_2.7 This issue/PR affects Ansible v2.7 docs This issue/PR relates to or includes documentation. needs_triage Needs a first human triage before being processed. small_patch support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Aug 6, 2018
@bcoca
Copy link
Member

bcoca commented Aug 6, 2018

#43724

@ansibot ansibot removed the needs_triage Needs a first human triage before being processed. label Aug 6, 2018
@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 Aug 15, 2018
@acozine
Copy link
Contributor

acozine commented Aug 27, 2018

@ctorgalson thanks for contributing to the documentation! We use sphinx to process our rST files. The correct syntax for anchors and links is:
.. _this_is_an_anchor:
:ref:'this_is_an_anchor' (but use backticks instead of single-quotes to surround the link) for a link with the text of the section header just under the anchor
:ref:'link text is different <this_is_an_anchor>' (again, use backticks not single-quotes) for a link with custom text

@acozine
Copy link
Contributor

acozine commented Aug 27, 2018

So for this specific example, you'd want :ref:'playbooks_variables'

@ctorgalson
Copy link
Contributor Author

Thanks @acozine. I think this PR will probably fade away and #43724 will be merged instead, but I've updated the link just in case :)

@ansibot ansibot removed 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 Aug 30, 2018
@acozine
Copy link
Contributor

acozine commented Aug 30, 2018

@ctorgalson I think both additions have merit (this PR and #43724). Thanks for updating the link.

@acozine acozine merged commit 2dfff57 into ansible:devel Aug 30, 2018
@acozine acozine added this to To do in OLD Ansible Documentation via automation Sep 17, 2018
@acozine acozine moved this from To do to Backport to 2.7 in OLD Ansible Documentation Sep 17, 2018
@acozine acozine moved this from Backport to 2.7 to Done in OLD Ansible Documentation Sep 20, 2018
@ansible ansible locked and limited conversation to collaborators Jul 22, 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 docs This issue/PR relates to or includes documentation. small_patch support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

5 participants