Skip to content

[codex] Fix certification review docs and metadata#40

Merged
madhansansel merged 2 commits into
mainfrom
ansible-certification-review-fixes
Jun 30, 2026
Merged

[codex] Fix certification review docs and metadata#40
madhansansel merged 2 commits into
mainfrom
ansible-certification-review-fixes

Conversation

@DNACENSolutions

Copy link
Copy Markdown

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update

Description

Please include a summary of the changes and the related issue. Also, include relevant motivation and context.

Bug Fix: Address certification review feedback across collection packaging metadata, the root README, CVP documentation, and role metadata.
Root Cause (if applicable): requirements.txt was excluded from the built artifact, Automation Hub-facing docs still contained relative links and GitHub-first support guidance, many CVP docs still instructed users to install Ansible with pip, and role metadata still advertised min_ansible_version: "2.14" after the collection minimum moved to >=2.16.0.
Fix Implemented: Removed requirements.txt from build_ignore, aligned the root README license/support/release-notes guidance, converted bundled CVP and role documentation links to absolute GitHub URLs, updated certified-support wording to use Automation Hub Create issue, switched CVP install guidance to EE-friendly SDK-only examples, and raised all role min_ansible_version values to 2.16.

Enhancement: Improve certification readiness for published collection artifacts and bundled documentation.
Enhancement Description: Standardized user-facing guidance for certified content and removed documentation patterns that do not render or compose well on Automation Hub / Execution Environments.
Impact Area: README.md, galaxy.yml, CVP_GUIDE.md, cvp/**/README.md, and roles/**/meta/main.yml.

Testing Done:

  • Manual testing
  • Unit tests
  • Integration tests

Test cases covered:

  • ansible-galaxy collection build --force --output-path /tmp/cc-build-check
  • Verified built tarball includes top-level requirements.txt
  • ansible-test sanity --local --color yes $(git diff --name-only) from a temporary ansible_collections/cisco/catalystcenter layout
  • Validated generated GitHub/raw documentation URLs resolve to repository paths

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • All the sanity checks have been completed and the sanity test cases have been executed

Ansible Best Practices

  • Tasks are idempotent (can be run multiple times without changing state)
  • Variables and secrets are handled securely (e.g., using ansible-vault or environment variables)
  • Playbooks are modular and reusable
  • Handlers are used for actions that need to run on change

Documentation

  • All options and parameters are documented clearly.
  • Examples are provided and tested.
  • Notes and limitations are clearly stated.

Screenshots (if applicable)

Notes to Reviewers

  • This PR is documentation/metadata-only; no controller or network deployment actions were performed.
  • The unchecked Ansible Best Practices items are not applicable because no task or playbook execution logic changed.
  • Unit and integration suites were not run because the changes are limited to documentation and metadata.

Comment thread cvp/lan_automation/README.md Outdated
Comment thread cvp/swim/README.md Outdated

## Demo Video
[![Device Software Upgrade Demo](./images/swimdemo.png)](http://3.136.0.140/iac_demos/swim/SWIMDEMO.mp4)
[![Device Software Upgrade Demo](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/swim/images/swimdemo.png)](http://3.136.0.140/iac_demos/swim/SWIMDEMO.mp4)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please check the following link?
(http://3.136.0.140/iac_demos/swim/SWIMDEMO.mp4)

Comment thread cvp/sda_port_assignment_migration/README.md Outdated
@madhansansel madhansansel merged commit c840791 into main Jun 30, 2026
22 of 23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants