Update links to AWS module guidelines to target the devel docsite since it's been removed from devel #57465
Conversation
ansibot
added
affects_2.8
the GUIDELINES.md has been removed from devel on github.
orthanc
force-pushed
the
update-aws-guidelines-link
branch
from
da1f9b0
to
04d4d5e
Compare
orthanc
changed the title
|
Discussion on #ansible-docs decided that best approach was to link to the devel docsite so people get the updated documentation rather than the out of date version in stable-2.8 branch. Latest updates switch the link to devel docsite. |
|
Summarising discussion from #ansible-docs so it's not lost: This collection of PRs fixes the broken links by pointing at the devel doc site. But this means that the behaviour of old docs is slightly better than what will happen when 2.9 is released. We really want module developers to always use the latest developer docs since any new modules will go into devel, not the curretly published version. But a side affect of moving these docs into the docsite is that the most easily discoverable version is the the current release of ansible rather than the current state of devel. So at some point it might be good to split develop docs into a seperate docsite that only has the current state from devel. That way they're always current. Links from the main ansible docs would then always go to the current developer docs. Full credit to @acozine for naming this concept "developers den" |
|
Thanks @orthanc for spotting the broken link, for submitting the PR with excellent summary, and for the naming credit for the Ansible Developers Den (as I type that, I realized it's even a multi-layered pun in English - "ADD" could describe development activity and/or my own mentality . . . )! Related to #42178. There are other pages that should only be published from the |
SUMMARY
Guidelines for AWS modules have been moved into the docsite. However the currently published docsite for 2.8 (and previous versions) still link to the old GUIDELINES.md file.
As a result we have a broken link in the published doc and it's difficult to find the contributing guidelines if you don't already know they exist.
This updates the links to this file in the 2.8 docs to refer to the devel docsite. While this is inconsistent with the rest of the dev guides that link to the same version, discussion on #ansible-docs came to the conclusion that this was the best option since we want developers building modules to use the latest guidelines.
Related PRs:
cc: @acozine
ISSUE TYPE
COMPONENT NAME
aws docs