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

Doc(eos_cli_config_gen): Add Documentation for Management Console #1332

Merged
merged 2 commits into from
Nov 22, 2021

Conversation

ccsnw
Copy link
Contributor

@ccsnw ccsnw commented Nov 16, 2021

Change Summary

Adding documentation for Management Console

Related Issue(s)

Fixes #1271

Component(s) name

arista.avd.eos_cli_config_gen

Proposed changes

If management_console.idle_timeout is defined, render it in the documentation as:
"Management Console Timeout is set to < management_console.idle_timeout > minutes."

If required, I can add a case for tranlasting "0" to "disabled" instead of rendering "0 minutes"

How to test

Molecule run

Checklist

User Checklist

  • N/A

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: CI Updated CI scenario have been updated in the PR labels Nov 16, 2021
@tgodaA tgodaA changed the title Feat(eos_cli_config_gen): Add Documentation for Management Console (#1271) Feat(eos_cli_config_gen): Add Documentation for Management Console Nov 17, 2021
@tgodaA tgodaA changed the title Feat(eos_cli_config_gen): Add Documentation for Management Console Doc(eos_cli_config_gen): Add Documentation for Management Console Nov 17, 2021
@tgodaA
Copy link
Contributor

tgodaA commented Nov 17, 2021

This PR is adding document, so this should be Doc(eos_cli_config_gen).

FYI:

  1. Feat - Feature update or add new feature
  2. Fix - Bug fix
  3. Doc - All documentation related issues

Also we don't add linked issue # in the PR title. We just link the related issues.

Copy link
Contributor

@tgodaA tgodaA left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor

@ClausHolbechArista ClausHolbechArista left a comment

Choose a reason for hiding this comment

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

LGTM

@ClausHolbechArista ClausHolbechArista merged commit 64084c5 into aristanetworks:devel Nov 22, 2021
@ccsnw ccsnw deleted the management-console branch November 22, 2021 17:59
@carlbuchmann carlbuchmann added this to the v3.2.0 milestone Dec 7, 2021
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 state: CI Updated CI scenario have been updated in the PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Management Console Missing from Device Documentation
4 participants