Skip to content

Windows documentation could be improved #423

Description

@skomp

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions