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

fixes broken link in aci module docs #39247

Merged
merged 2 commits into from
Apr 27, 2018
Merged

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.

The documentation for the aci_bd_to_l2out refers to a non-existent module (aci_l2out), triggering a WARNING: undefined label error. I made an educated guess as to where that link should point. If this is not the correct target, please let me know.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

aci_bd_to_l2out module

ANSIBLE VERSION

2.5

@acozine acozine added networking Network category docs This issue/PR relates to or includes documentation. labels Apr 24, 2018
@acozine acozine requested a review from dagwieers April 24, 2018 18:23
@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 aci Cisco ACI community 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
@acozine acozine moved this from Docsite work to In progress in Ansible-maintained Collections Documentation Apr 24, 2018
@gundalow
Copy link
Contributor

Thanks to @jmcgill298 for the background
#37570 (WIP) will add aci_l2out, so we could:

  • Change the M(aci_l2out) to C(aci_l2out) now, and in 37570 they change it back

@@ -18,7 +18,7 @@
- Bind Bridge Domain to L3 Out on Cisco ACI fabrics.
notes:
- The C(bd) and C(l3out) parameters should exist before using this module.
The M(aci_bd) and M(aci_l3out) can be used for these.
The M(aci_bd) and M(aci_l3out_route_tag_policy) can be used for these.
Copy link
Contributor

Choose a reason for hiding this comment

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

That is incorrect. It really should be aci_l3out, which does not exist as a module yet, but is in the pipeline.

Currently users build the l3out using aci_rest. We have a ticket open wrt. this, the documentation is based on the legacy modules which did include the aci_l3out module but was pretty limited in functionality. We are waiting for ACI experts to guide us in how they see this work in the future.

@dagwieers
Copy link
Contributor

It's aci_l3out, but that's just a detail. (l2out exists too)

@gundalow
Copy link
Contributor

OK, so will change to
The M(aci_bd) and C(aci_l3out) can be used for these. then in #37570 the link can be restored

@acozine
Copy link
Contributor Author

acozine commented Apr 27, 2018

Thanks @gundalow, @dagwieers and @jmcgill298. I've made the correct fix.

@dagwieers dagwieers merged commit 4801bf9 into ansible:devel Apr 27, 2018
Ansible-maintained Collections Documentation automation moved this from In progress to Done Apr 27, 2018
@acozine acozine deleted the aci_docs_fix branch April 27, 2018 19:34
acozine pushed a commit to acozine/ansible that referenced this pull request Apr 27, 2018
* fixes broken link in aci module docs

* makes correct fix for aci broken link

(cherry picked from commit 4801bf9)
acozine pushed a commit that referenced this pull request Apr 30, 2018
* fixes broken link in aci module docs

* makes correct fix for aci broken link

(cherry picked from commit 4801bf9)
oolongbrothers pushed a commit to oolongbrothers/ansible that referenced this pull request May 12, 2018
* fixes broken link in aci module docs

* makes correct fix for aci broken link
oolongbrothers pushed a commit to oolongbrothers/ansible that referenced this pull request May 14, 2018
* fixes broken link in aci module docs

* makes correct fix for aci broken link
oolongbrothers pushed a commit to oolongbrothers/ansible that referenced this pull request May 14, 2018
* fixes broken link in aci module docs

* makes correct fix for aci broken link
oolongbrothers pushed a commit to oolongbrothers/ansible that referenced this pull request May 15, 2018
* fixes broken link in aci module docs

* makes correct fix for aci broken link
oolongbrothers pushed a commit to oolongbrothers/ansible that referenced this pull request May 15, 2018
* fixes broken link in aci module docs

* makes correct fix for aci broken link
ilicmilan pushed a commit to ilicmilan/ansible that referenced this pull request Nov 7, 2018
* fixes broken link in aci module docs

* makes correct fix for aci broken link
@dagwieers dagwieers added the cisco Cisco technologies label Feb 23, 2019
@ansible ansible locked and limited conversation to collaborators Apr 29, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
aci Cisco ACI community cisco Cisco technologies 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. networking Network category 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