Delta between hello_world.md code and cdk init results

Open
#363 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Read the “Add an Amazon S3 bucket” section in hello_world.md and compare it with lib/hello-cdk-stack.ts from the starter app. Confirm why the constructor signatures differ, then align the documentation with the first sample app and explain the distinction; done means the documented code matches what customers see.

Written by the indexing model from the issue text.

Description

Section "Add an Amazon S3 bucket" source for tsc reads constructor(scope: cdk.App, id: string, props?: cdk.StackProps) {. When I open lib/hello-cdk-stack.ts, the starter code reads constructor(scope: cdk.Construct, id: string, props?: cdk.StackProps) {. What is the difference between cdk.App and cdk.Construct? Can we align the docs to what customers see in the first sample app?

Dominant language
Perl
Stars
360
Forks
230
Avg merge
3d 23h
Merged PRs (30d)
1

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from awsdocs/aws-cdk-guide

All issues in awsdocs/aws-cdk-guide

Similar issues

More Perl issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.