superluminar-io / serverless-workshop

Hands-on AWS serverless workshop for beginners
https://workshop.superluminar.io
MIT License
4 stars 1 forks source link

Windows documentation could be improved #423

Open skomp opened 2 years ago

skomp commented 2 years ago

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.
HenrikFricke commented 2 years ago

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.