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

Documentation to use VSCode container for demo & testing #571

Merged
merged 3 commits into from
Jan 6, 2021
Merged

Documentation to use VSCode container for demo & testing #571

merged 3 commits into from
Jan 6, 2021

Conversation

titom73
Copy link
Contributor

@titom73 titom73 commented Dec 31, 2020

Change Summary

Add content about new VScode container

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)

N/A

Component(s) name

  • Website
  • Makefile

Proposed changes

  • New How-to to explain how to leverage VSCode for demo & testing
  • Update Makefile to allow user to start VScode container to edit files quickly
  • Add new target in Makefile to refresh deployed Makefile from AVD

How to test

# Start dev stack
$ make start

# Connect to MKDOC server
$ open http://127.0.0.1:8000/docs/how-to/vscode-container/

# Test VSCode container with default port mapping 8080
$ make vscode 

# Test VSCode container with custom port mapping
$ make vscode VSCODE_PORT=8081

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

- Add new target for starting a vscode container
- Add new target to allow user to refresh makefile with new version from
  AVD
@github-actions github-actions bot added type: code quality CI and development toolset type: documentation Improvements or additions to documentation labels Dec 31, 2020
@titom73 titom73 added this to the v1.2.0 milestone Dec 31, 2020
@titom73 titom73 changed the title Initial VSCode draft Documentation to use VSCode container for demo & testing Dec 31, 2020
@titom73 titom73 merged commit bfcd456 into aristanetworks:devel Jan 6, 2021
@titom73 titom73 deleted the documentation/vscode-container branch January 6, 2021 07:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: code quality CI and development toolset type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant