search

IBM / z_ansible_collections_doc

Repository for Z collections documentation
Apache License 2.0
8 stars 8 forks source link

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

Closed ddgandhi closed 9 months ago

ddgandhi commented 9 months ago
SUMMARY

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

ISSUE TYPE
ddimatos commented 9 months ago

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 commented 9 months ago

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