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.

Sign up for GitHub

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

Jump to bottom

Doc: Migrating documentation to MD and within modules #678

Merged
merged 15 commits into from
Nov 20, 2023
Merged

Doc: Migrating documentation to MD and within modules #678

merged 15 commits into from
Nov 20, 2023

Conversation

JulioPDX
Copy link
Contributor

@JulioPDX JulioPDX commented Oct 12, 2023 •
edited by sugetha24
Loading

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

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

@github-actions github-actions bot requested a review from sugetha24 October 12, 2023 21:55
@github-actions github-actions bot added module: cv_configlet Issue related to cv_configlet module module: cv_configlet_v3 Issue related to cv_cononfiglet module in v3 module: cv_container Issue related to cv_container module module: cv_container_v3 Issue related to cv_container module in v3 module: cv_device Issue related to cv_device module module: cv_device_v3 Issue related to cv_device module in v3 module: cv_facts Issue related to cv_facts module module: cv_facts_v3 module: cv_task Issue related to cv_task module module: cv_task_v3 Issue related to cv_tasks module in v3 type: documentation Improvements or additions to documentation labels Oct 12, 2023
@sugetha24 sugetha24 modified the milestones: v3.9.0, v3.8.0 Nov 1, 2023
@github-actions github-actions bot added the type: Code quality Issue related to code quality in repository label Nov 7, 2023
This was referenced Nov 8, 2023
Closed
Closed
Closed
@sugetha24
Copy link
Contributor

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
Copy link
Contributor Author

JulioPDX commented Nov 8, 2023

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
Copy link
Contributor

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!

sugetha24
sugetha24 approved these changes Nov 9, 2023
View reviewed changes
Copy link
Contributor

@sugetha24 sugetha24 left a comment

Choose a reason for hiding this comment

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

LGTM

@github-actions github-actions bot requested a review from sugetha24 November 9, 2023 21:59
@github-actions github-actions bot requested a review from sugetha24 November 13, 2023 23:17
@sugetha24 sugetha24 mentioned this pull request Nov 14, 2023
Closed
4 tasks
noredistribution
noredistribution reviewed Nov 18, 2023
View reviewed changes
Copy link
Contributor

@noredistribution noredistribution left a comment

Choose a reason for hiding this comment

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

Wow, awesome job! Thanks for doing this!
Since we are updating the docs can we also fix some of the typos we have?
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

otherwise lgtm!

@github-actions github-actions bot requested a review from sugetha24 November 20, 2023 21:49
carlbuchmann
carlbuchmann approved these changes Nov 20, 2023
View reviewed changes
Copy link
Member

@carlbuchmann carlbuchmann left a comment

Choose a reason for hiding this comment

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

LGTM

@carlbuchmann
Copy link
Member

carlbuchmann commented Nov 20, 2023 •
edited
Loading

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

@sugetha24 sugetha24 merged commit 2258ca5 into aristanetworks:devel Nov 20, 2023
23 checks passed
@sugetha24 sugetha24 mentioned this pull request Jan 8, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@noredistribution noredistribution noredistribution left review comments

@carlbuchmann carlbuchmann carlbuchmann approved these changes

@sugetha24 sugetha24 Awaiting requested review from sugetha24

Assignees

@JulioPDX JulioPDX

Labels
module: cv_configlet_v3 Issue related to cv_cononfiglet module in v3 module: cv_configlet Issue related to cv_configlet module module: cv_container_v3 Issue related to cv_container module in v3 module: cv_container Issue related to cv_container module module: cv_device_v3 Issue related to cv_device module in v3 module: cv_device Issue related to cv_device module module: cv_facts_v3 module: cv_facts Issue related to cv_facts module module: cv_task_v3 Issue related to cv_tasks module in v3 module: cv_task Issue related to cv_task module type: Code quality Issue related to code quality in repository type: documentation Improvements or additions to documentation
Projects
None yet
Milestone
v3.9.0
4 participants
@JulioPDX @sugetha24 @carlbuchmann @noredistribution