Fix broken module documentation links in the README.md file #446
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…umentation site for all links.
kerry-meyer
changed the title
ArunSaravananBalachandran
requested changes
Sep 6, 2024
ArunSaravananBalachandran
approved these changes
Sep 6, 2024
stalabi1
approved these changes
Sep 6, 2024
kerry-meyer
added a commit
that referenced
this pull request
Sep 17, 2024
* In the enterprise_sonic README.md file, use the new Galaxy module documentation site for all links. * Add a changelog fragment for this PR. * Fix incorrect global regex results. * Change the fragment designation to "trivial" to match changing the PR type to "documentation". * Delete changed, redundant fragment file.
kerry-meyer
added a commit
that referenced
this pull request
Sep 17, 2024
* Enable system auditd and ip loadshare hash downward compatibility (#441) * Enable system auditd and ip loadshare hash downward compatibility. * Add a fragment file. * Add mock handling for edit_config_catch * Fix sanity errors. * Fix mistakes in the fragment file. * Modify the fix to operation on individual requests in the enterprise_sonic httpapi plugin. * Enable conditional suppression of GET exceptions. * Fix handling for an empty GET response. * Fix an indentation in the PoE facts file and fix global PoE empty configuration handling. * Update regex expression in edit_config method (#443) * Update regex expression in edit_config method * Change fragment to bugfix * Update 443-update-regex-edit-config.yaml * Add import of the Ansible ConnectionError exception class for all files where it is used. (#445) * Add import of the Ansible ConnectionError exception class for all files where it is used. * Add a fragment file. * Fix broken module documentation links in the README.md file (#446) * In the enterprise_sonic README.md file, use the new Galaxy module documentation site for all links. * Add a changelog fragment for this PR. * Fix incorrect global regex results. * Change the fragment designation to "trivial" to match changing the PR type to "documentation". * Delete changed, redundant fragment file. --------- Co-authored-by: stalabi1 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SUMMARY
Ansible/Redhat has moved the location for automatically generated module documentation from a location in the "docs.ansible.com" domain to a new location in the "galaxy.ansible.com" domain. This change set modifies the module documentation links used in the README.md file for this resource module collection to use the new location instead of the deprecated old location. These changes are also intended to fix the module documentation links in the embedded, derived content for this resource module collection on the web page at "https://galaxy.ansible.com/ui/repo/published/dellemc/enterprise_sonic/docs/".
GitHub Issues
List the GitHub issues impacted by this PR. If no Github issues are affected, please indicate this with "N/A".
ISSUE TYPE
COMPONENT NAME
README
OUTPUT
Result of accessing a module documentation link (for the qos_interfaces module) without the changes:
Result of accessing the same module documentation link (for the qos_interfaces module) after the changes:
ADDITIONAL INFORMATION
Checklist:
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Please also list any relevant details for your test configuration
Verify that previously failing links are now working correctly.