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

#274 - add template for management ssh documentation #290

Merged
merged 1 commit into from
Oct 26, 2020
Merged

#274 - add template for management ssh documentation #290

merged 1 commit into from
Oct 26, 2020

Conversation

ksator
Copy link
Contributor

@ksator ksator commented Oct 14, 2020

Change Summary

add a template for management ssh documentation

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)

fix #274

Component(s) name

eos_cli_config_gen role

Proposed changes

  • add a template for management ssh documentation
  • include the added template in the parent template

How to test

Checklist:

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

@ksator ksator added this to the v1.1.1 milestone Oct 14, 2020
@ksator ksator self-assigned this Oct 14, 2020
@ksator ksator added role: eos_cli_config_gen issue related to eos_cli_config_gen role type: documentation Improvements or additions to documentation labels Oct 14, 2020
@ksator
Copy link
Contributor Author

ksator commented Oct 14, 2020

Should we also include a table?
Or do we consider the configuration of this feature readable enought (so there is no need to include a table in addition to the configuration)?

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!

@titom73
Copy link
Contributor

titom73 commented Oct 25, 2020

Should we also include a table?
Or do we consider the configuration of this feature readable enought (so there is no need to include a table in addition to the configuration)?

Table of content should be part of a different PR to make it easier to track

@ksator ksator merged commit cc6b2d3 into aristanetworks:devel Oct 26, 2020
@ksator ksator deleted the issue/274 branch October 28, 2020 20:28
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 type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Management SSH Device Documentation Template to be completed
2 participants