README copy&paste issue?

Open Beginner friendly
#75 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
aws
Domain
documentation

Research direction

Start by comparing aws_quickstart/README.md with aws/README.md and checking the linked stack URLs. Update the quickstart README so its content is relevant and its links use the quickstart S3 URL; done when it no longer duplicates inappropriate AWS integration instructions and points to the intended quickstart stack.

Written by the indexing model from the issue text.

Description

Expected Behavior

Quickstart guide README should contain relevant information.

Actual Behavior

Actually, it seems to be copied and pasted from the AWS integration readme as the whole purpose of the quickstart guide seems to be the removal of the step 1.
And the links to the stacks are identical, but the quick start guide link should be https://datadog-cloudformation-template-quickstart.s3.amazonaws.com/aws/main_v2.yaml instead of https://datadog-cloudformation-template.s3.amazonaws.com/aws/main_v2.yaml

Steps to Reproduce the Problem

  1. RTFM :)
Dominant language
Python
Stars
47
Forks
58
Avg merge
1d 18h
Merged PRs (30d)
8

Contributor guide

Open the contributing guide

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 DataDog/cloudformation-template

All issues in DataDog/cloudformation-template

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.