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

updated CLI docs for salt-ssh #44322

Merged
merged 2 commits into from Oct 30, 2017

Conversation

rossengeorgiev
Copy link
Contributor

@rossengeorgiev rossengeorgiev commented Oct 28, 2017

What does this PR do?

  • Adds missing options from the salt-ssh cli docs
  • Updates order and sections of exists options

What issues does this PR fix or reference?

Resolves #44313

Copy link
Contributor

@rallytime rallytime left a comment

Choose a reason for hiding this comment

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

Thank you for updating these docs @rossengeorgiev. I had two small comments.

@@ -19,13 +19,17 @@ Salt SSH allows for salt routines to be executed using only SSH for transport
Options
=======

.. option:: -r, --raw, --raw-shell
.. program:: salt
Copy link
Contributor

Choose a reason for hiding this comment

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

salt --> salt-ssh

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Didn't even notice that, I only moved that line around.


.. option:: -s, --static

Return the data from minions as a group after they all
Copy link
Contributor

Choose a reason for hiding this comment

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

This description isn't quite complete. Maybe missing return at the end of the sentence?

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

Successfully merging this pull request may close these issues.

None yet

2 participants