Generate docs for version v1.7.0-beta.2

fernandofloresg commented 10 months ago

SUMMARY

As part of ibm_zos_core collection v1.7.0-beta.2 release, the docs have been updated, latest is on main branch.

ISSUE TYPE

Update Collection

ADDITIONAL INFORMATION

UPDATE REGISTRY.YML


################################################################################
# Copyright (c) IBM Corporation 2020, 2021
################################################################################

################################################################################
# Configuration for Red Hat certified collections as part of the
# IBM Red Hat Certified Collection on Z offering
#
# For documentation to be generated and included in the offering pending the
# certfied registry process you must also include the required fields below.
#
# Instructions:
#  <item>: The collection repository name as a dictionary element such as
#          'ibm_zos_core', 'ibm_zos_ims', etc
#  git:    The collection repository git url such as 'bm_zos_core.git'
#  stable: The Git tag or branch name to generate stable documenation.
#  latest: The Git tag or branch name to generate latest documenation.
#
# Notes:
#   Only one version of documetation is currently generated and supported.
#   Documentation is only generator for the latest branch or tag, there is plans
#   to support both latest and stable in the near future.
################################################################################
collections:
  ibm_zos_core:
    git: git@github.com:ansible-collections/ibm_zos_core.git
    stable:
    latest: main
    origin: main
  ibm_zos_ims:
    git: git@github.com:ansible-collections/ibm_zos_ims.git
    stable:
    latest: main
    origin: main
  ibm_zos_cics:
    git: git@github.com:ansible-collections/ibm_zos_cics.git
    stable:
    latest: main
    origin: main
  zhmc-ansible-modules:
    git: git@github.com:zhmcclient/zhmc-ansible-modules.git
    stable:
    latest: 1.4.1 
    origin: master
  ibm_zos_sysauto:
    git: git@github.com:ansible-collections/ibm_zos_sysauto.git
    stable:
    latest: v1.0.1
    origin: main
  ibm_zosmf:
    git: git@github.com:IBM/ibm_zosmf.git
    stable:
    latest: dev
    origin: main

itsBryantP commented 10 months ago

Doc site has been refreshed for z/OS Core release 1.7.0-beta.2 per commit f305e40.

Coloring of module params was lost which is a known issue that needs to be addressed.

@fernandofloresg and I also both experienced an issue with the site-deploy.yml playbook where it seems the behavior of the partial invocation of site-teardown.yml was incorrectly deleting parent files and directories above what is specified in the playbooks which was very puzzling, but due to lack of time to spend debugging the issue further, I opted for a manual deployment of the updated docs so that we can re-visit the deployment playbook issue at a later time.

ddimatos commented 7 months ago

@itsBryantP - I am not seeing or completely understanding the issue, a month back I walked @fernandofloresg through the process and had success, we did see some edit he had made in his version of the site-builder.yml that when reverted all worked fine.

As for the lost coloring, that can be corrected by using the requirements.txt specific in this repository, I just updated the setup.py in PR #46 and built a new venv using it and had no issues with coloring. I will say the frozen versions in the requirements.txt are concerning , I have an issue open on Ansible-extractor where in ansible-core 2.15 we will not be able to build doc. So as time progress and we reach a point when ansible-core 2.14 goes out of service we will have had to solve the issue.

If there continues to be an issue noted above, can a new issue be opened so we can close this one as this one is to generate doc and we can close it out.

itsBryantP commented 7 months ago

@ddimatos - thanks for revisiting this, I would have to go back and try generating again to see if this is still a problem. At the time the coloring also didn't seem to correct itself when switching between old and new requirements.txt. Now that I have a new machine, when time permits I can attempt to generate the docs with to confirm if there are still any issues. This issue can be closed for now.

itsBryantP commented 7 months ago

@ddimatos I got back around to this and regenerated this time without any issues, so considered the reported issue above resolved.

IBM / z_ansible_collections_doc