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

point at corresponding version #59200

Merged
merged 1 commit into from
Jul 25, 2019
Merged

Conversation

bcoca
Copy link
Member

@bcoca bcoca commented Jul 17, 2019

modules were always pointing at latest

fixes #54736

ISSUE TYPE
  • Bugfix Pull Request
  • Docs Pull Request
COMPONENT NAME

ansible-doc

@ansibot ansibot added affects_2.9 This issue/PR affects Ansible v2.9 bug This issue/PR relates to a bug. core_review In order to be merged, this PR must follow the core review workflow. needs_triage Needs a first human triage before being processed. support:community This issue/PR relates to code supported by the Ansible community. support:core This issue/PR relates to code supported by the Ansible Engineering Team. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed core_review In order to be merged, this PR must follow the core review workflow. labels Jul 17, 2019
@acozine acozine removed the needs_triage Needs a first human triage before being processed. label Jul 18, 2019
@acozine
Copy link
Contributor

acozine commented Jul 18, 2019

CI failures seem unrelated to the changes. Kicking off a new run.

@ansibot ansibot removed the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. label Jul 18, 2019
@acozine
Copy link
Contributor

acozine commented Jul 19, 2019

I published this branch to the test site and went to compare the old/bad/wrong behavior in prod against the new/good/correct behavior introduced by this PR . . . and now I can't replicate the bug. In the module docs, the seealso links point to the same version as the originating page. It's odd, I don't quite know what to think, but I'm going to leave this PR open until Monday.

@bcoca
Copy link
Member Author

bcoca commented Jul 22, 2019

@acozine you would have to use stable branches to reproduce the issue:
using 'stable-2.8' I run ansible-doc copy and I get:

SEE ALSO:
      * Module assemble
           The official documentation on the assemble module.
           https://docs.ansible.com/ansible/latest/modules/assemble_module.html

which is 'correct' for now, but once 2.9 is released .. it won't be

with PR i get

SEE ALSO:
      * Module assemble
           The official documentation on the assemble module.
           https://docs.ansible.com/ansible/2.8/modules/assemble_module.html

which should 'always' be true

@bcoca bcoca added the docs This issue/PR relates to or includes documentation. label Jul 22, 2019
@acozine
Copy link
Contributor

acozine commented Jul 23, 2019

I thought this behavior happened in the published docs as well, and happened in devel - i.e. I thought links in the See Also section in the devel docs were pointing at latest. But I can't recreate that behavior now.

+1 to merging this fix. When 2.9 comes out we can test the behavior in the published docs again.

@acozine acozine requested a review from abadger July 23, 2019 14:41
@akatch
Copy link
Contributor

akatch commented Jul 25, 2019

I'm curious as to why the condtional on description existing for the item was removed in this change. Can you elaborate?

@bcoca
Copy link
Member Author

bcoca commented Jul 25, 2019

@akatch that was existing, i just refactored the 'common parts' out of it, so took 11 lines down to 3

@akatch
Copy link
Contributor

akatch commented Jul 25, 2019 via email

@ansibot ansibot added shipit This PR is ready to be merged by Core and removed core_review In order to be merged, this PR must follow the core review workflow. labels Jul 25, 2019
@bcoca bcoca merged commit a5d409a into ansible:devel Jul 25, 2019
@bcoca bcoca deleted the show_versioned_docs branch July 25, 2019 15:54
@ansible ansible locked and limited conversation to collaborators Aug 22, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.9 This issue/PR affects Ansible v2.9 bug This issue/PR relates to a bug. docs This issue/PR relates to or includes documentation. shipit This PR is ready to be merged by Core support:community This issue/PR relates to code supported by the Ansible community. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make "See Also" links point to the same version the user is on
4 participants