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

Windows documentation could be improved #423

Open
skomp opened this issue Aug 17, 2022 · 1 comment
Open

Windows documentation could be improved #423

skomp opened this issue Aug 17, 2022 · 1 comment
Labels
enhancement New feature or request

Comments

@skomp
Copy link
Member

skomp commented Aug 17, 2022

Our focus was not so much on documentation for Windows users. There are some quirks in the documentation which lead to common errors. This list is probably by far incomplete.

  1. curl commands that pass data or set headers need different escaping and spaces, e.g. curl -X POST https://XXXXXX.execute-api.eu-central-1.amazonaws.com/prod/notes --data "{ \"title\": \"Hello World\", \"content\": \"abc\" }" -H 'Content-Type:application/json' -i, so headers must not have a space after the : apparently and single quotes work differently in PS (thanks @ba032759)
  2. We should have our own documentation about SSO credentials with PS. Oftentimes users click on "Windows" in the credentials dialogue in SSO. Unfortunately, nothing works then. As a hint we could add something "If you see a PS at the beginning of your shell prompt, you are most likely in Powershell"
  3. We should also have the setting of the environment variables documented for different systems, e.g. $Env:AWS_REGION="eu-central-1" for Powershell.
@skomp skomp added the enhancement New feature or request label Aug 17, 2022
@HenrikFricke
Copy link
Contributor

Thx for the valuable feedback! I'll add it to the project board. Not sure about the priority though. I see Windows computers being used by many clients, so it might be worth looking into it.

Spontaneous idea: I think we should introduce tabs on top of the commands in the documentation, so you can easily switch between macOS/Linux and Windows. Would be interesting to see if we can build this user interface with docsify easily.

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

No branches or pull requests

2 participants