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

Improve documentation on shells #3145

Closed
theunrepentantgeek opened this issue Jul 18, 2023 · 0 comments · Fixed by #3207
Closed

Improve documentation on shells #3145

theunrepentantgeek opened this issue Jul 18, 2023 · 0 comments · Fixed by #3207
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@theunrepentantgeek
Copy link
Member

theunrepentantgeek commented Jul 18, 2023

Describe the current behavior

Much of our documentation assumes the use of bash, causing difficulties for some users who are using different shells - such as CMD where ' quotes ' around crdPattern are not required (and in fact cause problems).

Describe the improvement

Depending on the page, either

  • Show the commands for each suported shell
  • Clearly call out that the example is for bash and highlight differences

Additional context

Specific issues that have been identified

  • bash will expand * to match any files, so crdPattern needs to be 'quoted' but other shells don't do this
  • Continuation characters for long commands differ
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

Successfully merging a pull request may close this issue.

2 participants