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: Improve schema generated docs #3321

Merged
merged 2 commits into from
Nov 10, 2023
Merged

Doc: Improve schema generated docs #3321

merged 2 commits into from
Nov 10, 2023

Conversation

ClausHolbechArista
Copy link
Contributor

@ClausHolbechArista ClausHolbechArista commented Nov 1, 2023 •
edited

Change Summary

Improve schema generated docs by including types, descriptions, restrictions in the YAML tab as well as cleaning up some styling for tables and links.

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.
  • I have updated molecule CI testing accordingly. (check the box if not applicable)

@github-actions github-actions bot added role: eos_cli_config_gen issue related to eos_cli_config_gen role state: Documentation role Updated role: eos_designs issue related to eos_designs role state: conflict PR with conflict labels Nov 1, 2023
@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 1, 2023

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@ClausHolbechArista ClausHolbechArista marked this pull request as ready for review November 8, 2023 06:41
@ClausHolbechArista
Copy link
Contributor Author

This one will be a never ending rebase, so please just review the current changes, and then we can rebase and rerun before merging.

@github-actions github-actions bot removed the state: conflict PR with conflict label Nov 10, 2023
@github-actions GitHub Actions
Copy link

Conflicts have been resolved. A maintainer will review the pull request shortly.

carlbuchmann
carlbuchmann approved these changes Nov 10, 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.

Looks great!

@carlbuchmann carlbuchmann merged commit f2c72ac into aristanetworks:devel Nov 10, 2023
39 checks passed
jonxstill pushed a commit to jonxstill/ansible-avd that referenced this pull request Nov 14, 2023
@ClausHolbechArista @jonxstill
Doc: Improve schema generated docs (aristanetworks#3321)
284c035
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@carlbuchmann carlbuchmann carlbuchmann approved these changes

@noredistribution noredistribution Awaiting requested review from noredistribution

Assignees

@ClausHolbechArista ClausHolbechArista

Labels
rn: Doc role: eos_cli_config_gen issue related to eos_cli_config_gen role role: eos_designs issue related to eos_designs role state: Documentation role Updated
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@ClausHolbechArista @carlbuchmann