ansible-navigator icon indicating copy to clipboard operation
ansible-navigator copied to clipboard

Building dev docs for ansible-navigator

Open alisonlhart opened this issue 3 years ago • 2 comments
trafficstars

ISSUE TYPE
  • Doc issue
SUMMARY

There are currently no surfaced dev docs for ansible-navigator. Was working with @thedoubl3j on fixing issue #598 and had some trouble with building source and testing. We would like to start building some dev_docs to step through the process for anyone wanting to get started on developing features or bugfixing navigator issues.

Initial doc suggestions:

  • Getting started with developing ansible-navigator - environment set-up with vscode
  • Walkthrough/summary of src files
  • Overview of base entry points
  • Building from src and installing packages for testing
  • Testing process and examples

alisonlhart avatar Nov 24 '21 14:11 alisonlhart

while there is python docs, particularly around setup.py, surfacing as much info as possible to either the docs dir or even just a general dev guide I think will help out a lot for people either looking to hack a little bit on their own install of navigator or those looking to contribute.

thedoubl3j avatar Nov 24 '21 14:11 thedoubl3j

@alisonlhart @thedoubl3j This is a great idea!

cidrblock avatar Nov 29 '21 13:11 cidrblock