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

Suggest a minor doc change #168

Open
nzjc opened this issue Sep 6, 2020 · 2 comments
Open

Suggest a minor doc change #168

nzjc opened this issue Sep 6, 2020 · 2 comments

Comments

@nzjc
Copy link

nzjc commented Sep 6, 2020

In the docs for quick_start.rst

+Tip: When using Juniper devices, you need to enable netconf before Salt can connect to the device. This can be done by simply configuring set system services netconf ssh.

When following along at home, with fresh lab kit - it might be really helpful to mention that netconf needs to be enabled for the junos proxy/ napalm to actually work. This is probably true for Cisco too, but I wouldn't know. Appreciate you don't want to go down the prescriptive docs for everyone's problems - but this one caught me out.

@mirceaulinic
Copy link
Owner

👋 @nzjc. I think it'd be best to point the user to read the documentation for the appropriate Proxy Module / underlying library they're using. For example, if someone's using NAPALM, they should refer to https://napalm.readthedocs.io/en/latest/ etc.

That said, it wouldn't however hurt to have a note on the above and the Junos configuration as you suggested. Would you be willing to open a PR to improve this?

@mirceaulinic mirceaulinic added this to the APPROVED milestone Sep 9, 2020
@nzjc
Copy link
Author

nzjc commented Oct 2, 2020 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants