To contribute, you need to fork the repository, do your modifications and create a new pull request.

⚠️ Please make sure you have the full pyats package installed via pip install pyats[full].

To build the docs locally on your machine. Please follow the instructions below

• Go to the Unicon.plugins Github repository

• On the top right corner, click Fork. (see https://help.github.com/en/articles/fork-a-repo)

• In your terminal, clone the repo using the command shown below:

  git clone https://github.com/<your_github_username>/unicon.plugins.git

• cd unicon.plugins/docs

• Use make install_build_deps to install all of the build dependencies

• Run make docs to generate documentation in HTML

• Wait until you see Done in your terminal

• The documentation is now built and stored under the directory unicon.plugins/__build__

• Run make serve to view the documentation on your browser

  • Please create a PR after you have made your changes (see commit your changes & open a PR)

Here are a few examples that could be great pull request:

• Fix Typos
• Better wording, easier explanation
• More details, examples
• Anything else to enhance the documentation

• For detail on contributing to pyATS, please follow the contribution guidelines