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

Generate doc for IMS Collection release v1.3.0-beta.1 #53

Closed
ddgandhi opened this issue Dec 15, 2023 · 2 comments
Closed

Generate doc for IMS Collection release v1.3.0-beta.1 #53

ddgandhi opened this issue Dec 15, 2023 · 2 comments
Assignees
Labels
New Collection Request Used to request a new collection be added to the doc site Update Collection Request Used to update a collections registry branch or tag info

Comments

@ddgandhi
Copy link

SUMMARY

Need to generate documentation for IMS Collection release v1.3.0-beta.1

ISSUE TYPE
  • Update Collection
@ddgandhi ddgandhi added New Collection Request Used to request a new collection be added to the doc site Update Collection Request Used to update a collections registry branch or tag info labels Dec 15, 2023
@ddimatos
Copy link
Member

ddimatos commented Dec 16, 2023

There is an issue with the doc from the remote repository, the repository to pull dock from was not shared so I am using the tag, assuming that is correct:

  ibm_zos_ims:
    git: git@github.com:ansible-collections/ibm_zos_ims.git
    stable:
    latest: release-v1.3.0-beta.1
    origin: main

Then the issue is when doc is consumed by this repositories tooling an error occurred:

/Users/ddimatos/git/gh/z_ansible_collections_doc/source/reference/community.rst:14: WARNING: toctree contains reference to nonexisting document 'ibm_zos_ims/docs/source/community_guides'
looking for now-outdated files... none found

What this means is the community_guides.rst is not available under for IMS but other collections are not impacted.

The easiest fix is to branch fro the tag release-v1.3.0-beta.1, lets call that release-v1.3.0-beta.1-docfix, fix the doc, then reply here so we can then pull from the branch release-v1.3.0-beta.1-docfix that includes community_guides.rst.

This is the current live view of the doc:
image

This is how it looks now notice there is no IMS section:
image

Since this is isolated to IMS , I will push the updated doc but you should plan to fix this in a new branch and open an isssue.

@itsBryantP
Copy link
Member

Thanks @ddimatos. The missing community guidelines is fixed and the doc has been generated and published for the v1.3.0-beta.1 release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
New Collection Request Used to request a new collection be added to the doc site Update Collection Request Used to update a collections registry branch or tag info
Projects
None yet
Development

No branches or pull requests

3 participants