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

removes broken link to old module name #39249

Merged
merged 1 commit into from Apr 25, 2018

Conversation

acozine
Copy link
Contributor

@acozine acozine commented Apr 24, 2018

SUMMARY

As part of making all rST warnings fatal on Shippable, we are eliminating warnings from the docs build. This PR addresses one of these:

  • The documentation for the say module contains a link to its old name, triggering a WARNING: undefined label error. This PR retains the text but removes the link.
ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

say module

ANSIBLE VERSION

2.5

@acozine acozine added the docs This issue/PR relates to or includes documentation. label Apr 24, 2018
@acozine acozine added this to Docsite work in Ansible-maintained Collections Documentation via automation Apr 24, 2018
@ansibot
Copy link
Contributor

ansibot commented Apr 24, 2018

@ansibot ansibot added community_review In order to be merged, this PR must follow the community review workflow. module This issue/PR relates to a module. support:community This issue/PR relates to code supported by the Ansible community. labels Apr 24, 2018
@@ -21,7 +21,7 @@
description:
- makes a computer speak! Amuse your friends, annoy your coworkers!
notes:
- In 2.5, this module has been renamed from M(osx_say) into M(say).
- In 2.5, this module has been renamed from ``osx_say`` to M(say).
Copy link
Member

Choose a reason for hiding this comment

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

osx_say is still there as a symlink, unsure if this is the correct solution as this will be the case with any aliased module.

Copy link
Contributor

@gundalow gundalow Apr 24, 2018

Choose a reason for hiding this comment

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

Please change to:

from C(osx_say) to M(say)

No need to have a link from say to osx_say, as you'd end up on the same page

@acozine
Copy link
Contributor Author

acozine commented Apr 24, 2018

@gundalow fixed, thanks

@acozine acozine moved this from Docsite work to In progress in Ansible-maintained Collections Documentation Apr 24, 2018
@acozine acozine merged commit fdcf8c7 into ansible:devel Apr 25, 2018
Ansible-maintained Collections Documentation automation moved this from In progress to Done Apr 25, 2018
@acozine acozine moved this from Done to Needs Backport to 2.5 in Ansible-maintained Collections Documentation Apr 25, 2018
acozine pushed a commit to acozine/ansible that referenced this pull request Apr 25, 2018
@acozine acozine moved this from Needs Backport to 2.5 to Done in Ansible-maintained Collections Documentation Apr 25, 2018
@acozine acozine deleted the say_module_docs_fix branch April 25, 2018 19:09
oolongbrothers pushed a commit to oolongbrothers/ansible that referenced this pull request May 12, 2018
oolongbrothers pushed a commit to oolongbrothers/ansible that referenced this pull request May 14, 2018
oolongbrothers pushed a commit to oolongbrothers/ansible that referenced this pull request May 14, 2018
oolongbrothers pushed a commit to oolongbrothers/ansible that referenced this pull request May 15, 2018
oolongbrothers pushed a commit to oolongbrothers/ansible that referenced this pull request May 15, 2018
ilicmilan pushed a commit to ilicmilan/ansible that referenced this pull request Nov 7, 2018
@ansible ansible locked and limited conversation to collaborators Apr 27, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
community_review In order to be merged, this PR must follow the community review workflow. docs This issue/PR relates to or includes documentation. module This issue/PR relates to a module. support:community This issue/PR relates to code supported by the Ansible community.
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

4 participants