aws-amplify / aws-amplify/docs

[Feedback]Windows example for getting started tutorial

Open
#5,053 1 comment 0 reactions 0 assignees View on GitHub
amplify/js
Dominant language
MDX
Stars
506
Forks
1.1k
Avg merge
3h 14m
Merged PRs (30d)
1

Description

**Page**: [`/start/getting-started/installation/q/integration/[integration]`](https://docs.amplify.aws/start/getting-started/installation/q/integration/js)

**Feedback**:

It is vital that you clearly indicate the environment in which someone should attempt a tutorial. I installed the relevant components onto my windows laptop, including the amplify CLI. Then, on page 2, the commands to install the fullstack app stop working because, as one example, the -p flag for mkdir is clearly a linux flag and will not work in CMD. If we MUST use a server like environment or a linux environment then you MUST make that clear. Otherwise this tutorial, like so many others for AWS is a waste of time.

Contributor guide

Open the contributing guide

Research direction

Start at the linked getting-started installation page and inspect the second-page setup commands, especially the mkdir -p example, in the Windows context described. Done means the tutorial clearly states its supported environment and provides commands that work in Windows CMD or explicitly explains when a Linux-like environment is required.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, shell
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.