Doc: Migrating documentation to MD and within modules

JulioPDX commented 9 months ago

Change Summary

Move away from RST to generate documentation
doc.py file will read modules directory and generate the relevant markdown docs, no more intermediate with RST
Make file updates for new pointers to directories and script
Moved duplicate information from how-to section to live within the modules documentation
Deleted old files under how-to directory
Updated mkdocs with removal of how-tos relevant to modules
Created new output folder that can be used to display module output within module documentation
Updated link check workflow to match newer style with AVD

Related Issue(s)

Fixes #673 Fixes #674 Fixes #636 Fixes #643

Component(s) name

Docs

Proposed changes

Proposed changes listed under summary.

How to test

Locally install requirements and run mkdocs serve

Checklist

Repository Checklist

[x] My code has been rebased from devel before I start
[x] I have read the CONTRIBUTING document.
[x] My change requires a change to the documentation and documentation have been updated accordingly. (check the box if not applicable)
[x] I have updated molecule CI testing accordingly. (check the box if not applicable)

sugetha24 commented 8 months ago

Can we bump the min supported CVP version to 2021.2 according to EOL notice. @carlbuchmann maybe a PSA to the field might be needed?

JulioPDX commented 8 months ago

Can we bump the min supported CVP version to 2021.2 according to EOL notice. @carlbuchmann maybe a PSA to the field might be needed?

It may need to be higher, since 2021.2 reached EOL on Sep 2023

sugetha24 commented 8 months ago

Can we bump the min supported CVP version to 2021.2 according to EOL notice. @carlbuchmann maybe a PSA to the field might be needed?

It may need to be higher, since 2021.2 reached EOL on Sep 2023

yes. My bad, I meant to say we need to bump supported version to 2021.3 and up!

carlbuchmann commented 7 months ago

Only found one where the configlet_v3 example references v1 in https://github.com/aristanetworks/ansible-cvp/blob/devel/ansible_collections/arista/cvp/plugins/modules/cv_configlet_v3.py#L75

fixed in: 124908f

aristanetworks / ansible-cvp