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.

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

Eos_cli_config_gen Doc Standardization #460

Merged
merged 3 commits into from
Dec 11, 2020

Conversation

aphillipps
Copy link
Contributor

Change Summary

Eos_cli_config_gen Documentation Standardization

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes)
  • Documentation content changes
  • Other (please describe):

Related Issue(s)

Component(s) name

Eos_cli_config_gen

Proposed changes

Here is the list of items that have been standardized:

  • All titles with upper case
  • When item is not configured describe as follows in a table: '-'
  • When located in the default vrf or global routing table use default
  • When feature not defined use {{ feature }} not defined
  • No *** in titles, use ### instead (number of # corresponds to the title level in the doc)
  • For enabled/disabled entries use lower case in tables
  • For true/false entries use lower case in tables

How to test

Checklist:

  • I have read the CONTRIBUTING document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • All new and existing tests passed (pre-commit, make linting and make sanity-lint).
  • I have updated molecule CI testing accordingly

@aphillipps aphillipps added the role: eos_cli_config_gen issue related to eos_cli_config_gen role label Dec 10, 2020
@aphillipps aphillipps added this to the v1.1.2 milestone Dec 10, 2020
@aphillipps aphillipps requested a review from titom73 December 10, 2020 14:03
@titom73
Copy link
Contributor

titom73 commented Dec 10, 2020

Will review changes today.

Copy link
Contributor

@titom73 titom73 left a comment

Choose a reason for hiding this comment

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

LGTM!

Please check updates I did earlier

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

LGTM!

Please check updates I did earlier

Looks good thank you @titom73 and @aphillipps

@carlbuchmann carlbuchmann merged commit 9c25bd3 into aristanetworks:devel Dec 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
role: eos_cli_config_gen issue related to eos_cli_config_gen role
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants