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

Galaxy module links now broken #1020

Closed
1 task done
samccann opened this issue Sep 13, 2022 · 1 comment · Fixed by #1021
Closed
1 task done

Galaxy module links now broken #1020

samccann opened this issue Sep 13, 2022 · 1 comment · Fixed by #1021
Assignees

Comments

@samccann
Copy link
Contributor

Summary

Summary

This is a side effect of replacing the .rst files in the repo with a github-generated docsite.

This caused a few issues:
1 - galaxy readme links are now broken because the readme points to .rst files that were removed from the repo. This is probably fixed as soon as the next amazon.aws release picks up the new readme file.
2 - The new readme file always points to the main branch for docs. This means galaxy would not reflect the release that is on galaxy. One suggested fix would be to replace the existing link in the readme with a link to devel docs on docs.ansible.com (https://docs.ansible.com/ansible/devel/collections/amazon/aws/index.html). Alternately, consider the approach used at https://github.com/ansible-collections/community.hashi_vault/#collection-documentation which points to multiple versions.
3. the docsite in galaxy.yml should be updated as well. This one can be the devel docs link as what is latest in galaxy is devel on docs.ansible.com.

Issue Type

Documentation Report

Component Name

docs

Ansible Version

$ ansible --version

Collection Versions

$ ansible-galaxy collection list

Configuration

$ ansible-config dump --only-changed

OS / Environment

No response

Additional Information

Related to ansible-collections/community.aws#1461

Code of Conduct

  • I agree to follow the Ansible Code of Conduct
@ansibullbot
Copy link

Files identified in the description:

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

@tremble tremble self-assigned this Sep 13, 2022
softwarefactory-project-zuul bot pushed a commit that referenced this issue Sep 14, 2022
Update docs links

SUMMARY
fixes #1020
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
galaxy.yml
ADDITIONAL INFORMATION

Reviewed-by: Alina Buzachis <None>
patchback bot pushed a commit that referenced this issue Sep 14, 2022
Update docs links

SUMMARY
fixes #1020
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
galaxy.yml
ADDITIONAL INFORMATION

Reviewed-by: Alina Buzachis <None>
(cherry picked from commit 01069fa)
patchback bot pushed a commit that referenced this issue Sep 14, 2022
Update docs links

SUMMARY
fixes #1020
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
galaxy.yml
ADDITIONAL INFORMATION

Reviewed-by: Alina Buzachis <None>
(cherry picked from commit 01069fa)
tremble added a commit that referenced this issue Sep 14, 2022
Update docs links

SUMMARY
fixes #1020
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
galaxy.yml
ADDITIONAL INFORMATION

Reviewed-by: Alina Buzachis <None>
(cherry picked from commit 01069fa)
tremble added a commit that referenced this issue Sep 14, 2022
Update docs links

SUMMARY
fixes #1020
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
galaxy.yml
ADDITIONAL INFORMATION

Reviewed-by: Alina Buzachis <None>
(cherry picked from commit 01069fa)
softwarefactory-project-zuul bot pushed a commit that referenced this issue Sep 14, 2022
[PR #1021/01069fa0 backport][stable-4] Update docs links

This is a backport of PR #1021 as merged into main (01069fa).
SUMMARY
fixes #1020
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
galaxy.yml
ADDITIONAL INFORMATION

Reviewed-by: Mark Chappell <None>
softwarefactory-project-zuul bot pushed a commit that referenced this issue Sep 14, 2022
[PR #1021/01069fa0 backport][stable-3] Update docs links

This is a backport of PR #1021 as merged into main (01069fa).
SUMMARY
fixes #1020
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
galaxy.yml
ADDITIONAL INFORMATION

Reviewed-by: Mark Chappell <None>
softwarefactory-project-zuul bot pushed a commit that referenced this issue Sep 14, 2022
Prepare 4.2.0 Release

SUMMARY
A relatively minor release, but getting this out helps with #1020
(FYI @samccann)
ISSUE TYPE

Feature Pull Request

COMPONENT NAME
CHANGELOG.rst
changelogs/changelog.yaml
changelogs/fragments/*
galaxy.yml
ADDITIONAL INFORMATION

Reviewed-by: Alina Buzachis <None>
Reviewed-by: Sandra McCann <samccann@redhat.com>
Reviewed-by: Jill R <None>
tremble added a commit to tremble/amazon.aws that referenced this issue Sep 14, 2022
Prepare 4.2.0 Release

SUMMARY
A relatively minor release, but getting this out helps with ansible-collections#1020
(FYI @samccann)
ISSUE TYPE

Feature Pull Request

COMPONENT NAME
CHANGELOG.rst
changelogs/changelog.yaml
changelogs/fragments/*
galaxy.yml
ADDITIONAL INFORMATION

Reviewed-by: Alina Buzachis <None>
Reviewed-by: Sandra McCann <samccann@redhat.com>
Reviewed-by: Jill R <None>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants