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.

Sign up for GitHub

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

Jump to bottom

module links in galaxy now broken #1461

Closed
1 task done
samccann opened this issue Sep 13, 2022 · 2 comments · Fixed by #1462
Closed
1 task done

module links in galaxy now broken #1461

samccann opened this issue Sep 13, 2022 · 2 comments · Fixed by #1462
Assignees
@tremble
Labels
docs needs_triage

Comments

@samccann
Copy link

Summary

This is a side effect of #1436 which replaced 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 community.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 at https://github.com/ansible-collections/community.aws/blame/main/README.md#L38 with a link to devel docs on docs.ansible.com (https://docs.ansible.com/ansible/devel/collections/community/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 here - https://github.com/ansible-collections/community.aws/blob/main/galaxy.yml#L13 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

No response

Code of Conduct

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

More options from the DaWGs meeting:

the AWS collections also have another option since they use stable branches
in the galaxy.yml for those "not latest" branches, they could point to the docsites built by the GH workflows for those branches
but I don't know how difficult that would be to manage
I don't think they've been published yet, but the workflows are set up to do so
or it could point to the tag docs builds, which will be built when the tag is pushed
etc.

@tremble
Copy link
Contributor

tremble commented Sep 13, 2022

2 - The new readme file always points to the main branch for docs.

Thanks for the catch (and sorry I went silent in the meeting)

Bah, I could have sworn I caught this one. Must have only updated it for the workflows.

@samccann samccann mentioned this issue Sep 13, 2022
Closed
1 task
@tremble tremble self-assigned this Sep 13, 2022
@tremble tremble mentioned this issue Sep 14, 2022
Merged
softwarefactory-project-zuul bot pushed a commit that referenced this issue Sep 14, 2022
@tremble
Update Galaxy docs links (#1462)
cde1a56 
Update Galaxy docs links

SUMMARY
Fixes: #1461
(See also ansible-collections/amazon.aws#1021)
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
@tremble @patchback
Update Galaxy docs links (#1462)
35a4bf7 
Update Galaxy docs links

SUMMARY
Fixes: #1461
(See also ansible-collections/amazon.aws#1021)
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
galaxy.yml
ADDITIONAL INFORMATION

Reviewed-by: Alina Buzachis <None>
(cherry picked from commit cde1a56)
@patchback patchback bot mentioned this issue Sep 14, 2022
Merged
patchback bot pushed a commit that referenced this issue Sep 14, 2022
@tremble @patchback
Update Galaxy docs links (#1462)
8c75600 
Update Galaxy docs links

SUMMARY
Fixes: #1461
(See also ansible-collections/amazon.aws#1021)
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
galaxy.yml
ADDITIONAL INFORMATION

Reviewed-by: Alina Buzachis <None>
(cherry picked from commit cde1a56)
@patchback patchback bot mentioned this issue Sep 14, 2022
Merged
tremble added a commit that referenced this issue Sep 14, 2022
@tremble
Update Galaxy docs links (#1462)
0648362 
Update Galaxy docs links

SUMMARY
Fixes: #1461
(See also ansible-collections/amazon.aws#1021)
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
galaxy.yml
ADDITIONAL INFORMATION

Reviewed-by: Alina Buzachis <None>
(cherry picked from commit cde1a56)
tremble added a commit that referenced this issue Sep 14, 2022
@tremble
Update Galaxy docs links (#1462)
921387a 
Update Galaxy docs links

SUMMARY
Fixes: #1461
(See also ansible-collections/amazon.aws#1021)
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
galaxy.yml
ADDITIONAL INFORMATION

Reviewed-by: Alina Buzachis <None>
(cherry picked from commit cde1a56)
softwarefactory-project-zuul bot pushed a commit that referenced this issue Sep 14, 2022
@patchback
Update Galaxy docs links (#1462) (#1464)
6524c82 
[PR #1462/cde1a564 backport][stable-4] Update Galaxy docs links

This is a backport of PR #1462 as merged into main (cde1a56).
SUMMARY
Fixes: #1461
(See also ansible-collections/amazon.aws#1021)
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
@patchback
Update Galaxy docs links (#1462) (#1465)
e42e8e7 
[PR #1462/cde1a564 backport][stable-3] Update Galaxy docs links

This is a backport of PR #1462 as merged into main (cde1a56).
SUMMARY
Fixes: #1461
(See also ansible-collections/amazon.aws#1021)
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
galaxy.yml
ADDITIONAL INFORMATION

Reviewed-by: Mark Chappell <None>
@tremble tremble mentioned this issue Sep 14, 2022
Merged
softwarefactory-project-zuul bot pushed a commit that referenced this issue Sep 14, 2022
@tremble
Prepare 4.2.0 Release (#1466)
fbd19fe 
Prepare 4.2.0 Release

Depends-On: ansible-collections/amazon.aws#1024
SUMMARY
A relatively minor release, but getting this out helps with #1461
(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>
tremble added a commit to tremble/community.aws that referenced this issue Sep 14, 2022
@tremble
Prepare 4.2.0 Release (ansible-collections#1466)
03c5628 
Prepare 4.2.0 Release

SUMMARY

A relatively minor release, but getting this out helps with ansible-collections#1461

ISSUE TYPE

Feature Pull Request

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

Reviewed-by: Alina Buzachis
Reviewed-by: Sandra McCann
@tremble tremble mentioned this issue Sep 14, 2022
Merged
softwarefactory-project-zuul bot pushed a commit that referenced this issue Sep 14, 2022
@tremble
Prepare 4.2.0 Release (#1466) (#1469)
56d26c8 
Cleanup after 4.2.0 Release

SUMMARY
A relatively minor release, but getting this out helps with #1461
ISSUE TYPE

Docs Pull Request

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

Reviewed-by: Alina Buzachis <None>
abikouo pushed a commit to abikouo/community.aws that referenced this issue Oct 24, 2023
@alinabuzachis
Update aws_ec2 documentation for the use_ssm_inventory option (#1586)
463d588 
Update aws_ec2 documentation for the use_ssm_inventory option

SUMMARY

Update aws_ec2 documentation for the use_ssm_inventory option
Might fix ansible-collections#1461

ISSUE TYPE


Docs Pull Request

COMPONENT NAME

aws_ec2

Reviewed-by: Mark Chappell
Reviewed-by: Jill R
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tremble tremble

Labels
docs needs_triage
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update Galaxy docs links tremble/community.aws
3 participants
@tremble @samccann @ansibullbot