Let's document: aws

Question

Let's document: aws

Waples opened this issue 3 years ago · 56 comments

258204 commented 3 years ago

rds #6547

Answer 1 · 2021-03-31T11:05:56.000Z

@bl-ue whenever you are bored :P #HelpWanted :p

Answer 2 · 2021-03-31T14:29:21.000Z

Haha @Waples did you happen to see this: #5212?

Answer 3 · 2021-03-31T17:34:14.000Z

@Waples it looks like you might have removed all occurences of the letter o in the above command list 😄, e.g. alexafrbusiness, wrkmailmessageflw, applicatin-autscaling

Answer 4 · 2021-04-01T07:29:34.000Z

@Waples it looks like you might have removed all occurences of the letter o in the above command list , e.g. alexafrbusiness, wrkmailmessageflw, applicatin-autscaling

Owh haha, think i was a bit too agressive with my %s/\so^/g ish replace then xD will fix that in a second @bl-ue

Answer 5 · 2021-04-01T07:37:46.000Z

Fixed it =D

Answer 6 · 2021-04-01T07:48:08.000Z

@bl-ue didn't see that issue before, but that goes in a bit too deep with ALL the commands.
I was thinking more like, for example aws-ec2.md.

Answer 7 · 2021-04-01T11:47:34.000Z

You're right, that's why I closed it. But I wanted to link it for reference 👍🏻

Answer 8 · 2021-04-02T10:53:43.000Z

I'm gonna make some time today to add at least 15 examples, but I don't know what the best course of action is, a seperate branch for every page added or in one big PR ?
@bl-ue what ya want

Answer 9 · 2021-04-02T11:32:49.000Z

The former @Waples. Please open 1 PR per new page. It makes it easier to review the changes.

It would certainly be great if we could document all of the aws subcommands—I'd say they're probably looked for often 🤷🏻

Answer 10 · 2021-04-02T12:51:38.000Z

Organization status, here I come. xD

Answer 11 · 2021-04-02T15:03:35.000Z

I'd say they're probably looked for often 🤷🏻
sounds a bit sarcastic xD

Answer 12 · 2021-04-02T16:53:46.000Z

Haha no I wasn't intended to be sarcastic actually :)

Answer 13 · 2021-04-03T23:28:21.000Z

Oh wow, that's an enormous list @Waples! I'd suggest starting small, and opening just 1 or 2 PRs for 1 or 2 pages at a time to get used to the tldr page syntax if you haven't already got experience with the review process.

Answer 14 · 2021-06-16T11:47:35.000Z

Starting one on secrets manager now.

Answer 15 · 2021-06-16T20:05:27.000Z

Starting s3api and cur

Answer 16 · 2021-06-17T11:36:30.000Z

Might do ecs and eks next, everyone loves container orchestration.

Answer 17 · 2021-06-17T12:15:12.000Z

And do ecr — I'm going to upload some Docker images to ECR just today, and it would be cool to know how to use aws ecr! 🙂

Answer 18 · 2021-06-17T13:15:22.000Z

I will start on ecr first then.

Answer 19 · 2021-06-17T15:23:36.000Z

It's a spiderweb. You need a tldr of docker-login for a tldr or aws ecr.

Answer 20 · 2021-06-17T15:36:57.000Z

This actually brings up an important question.
The authoritative documentation is more complete (eg. https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/index.html), however, the quick start guide https://docs.aws.amazon.com/AmazonECR/latest/userguide/ is much more useful to get to know a new tool. It would deviate from the standard, but pages that include both would be more useful.

Answer 21 · 2021-06-17T15:42:20.000Z

Also need to add a short one for docker-tag

Answer 22 · 2021-06-17T15:43:50.000Z

And docker-image....

DOCUMENT ALL THE THINGS!!! :D

Answer 23 · 2021-06-17T15:45:11.000Z

Hmm, I'm not really sure. The first page does provide a lot more information directly related to the CLI (36 addition subcommands). The second page is tuned for beginners but isn't actually about the CLI.

I'm probably inclined to keep the first link, because it seems like a user who goes to that link might be looking for more info on how to use the tool itself, but there's equal argument for both links, so I'm chasing my own tail here. 😅

Answer 24 · 2021-06-17T15:51:33.000Z

The second link mirrors the same steps for cli and gui.

Answer 25 · 2021-06-17T15:58:45.000Z

I would suggest that for more information links subpages of https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/index.html (e.g. https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/get-lifecycle-policy-preview.html) are more directly relevant to each individual page.

The generic user guide looks useful, but not specifically to the aws subcommand being documented.

Answer 26 · 2021-06-17T16:01:08.000Z

Thanks @sbrl, I agree.

Answer 27 · 2021-06-17T19:48:38.000Z

And docker-image....

DOCUMENT ALL THE THINGS!!! :D

It's already there, my mistake, my package manager just didn't have the latest version of tldr.

Answer 28 · 2022-02-21T00:02:17.000Z

Thanks for all your work @258204 !
I've been very busy (work/private), hence why I didn't add anything so far to my "todo" list.
I'll take a look at the state of the AWS API tomorrow, to see if new services need to be added to the list.
I might have some time tomorrow to write some tldr pages, time will tell.

Answer 29 · 2022-10-02T17:01:39.000Z

aws sts #8669

Answer 30 · 2022-10-07T20:35:54.000Z

aws pricing #8804

Answer 31 · 2022-10-07T20:46:31.000Z

aws history #8805

Answer 32 · 2022-10-07T21:12:14.000Z

aws configure #8808

Answer 33 · 2022-10-15T17:51:38.000Z

Hi! I'll work on sqs command file

Answer 34 · 2022-10-15T18:32:10.000Z

aws-sqs: add page #9085

Answer 35 · 2023-02-04T19:20:19.000Z

Thank you @piraces @bryanmg for all your work!

Answer 36 · 2023-06-19T00:11:55.000Z

Note to self: check if the list still up to date with the v2 (and beta v3) version of aws-cli

Answer 37 · 2023-08-03T11:13:05.000Z

First timer trying to help.

aws-batch: add page #10591

Answer 38 · 2023-08-18T12:52:51.000Z

aws-cloudwatch: add page #10614

Answer 39 · 2023-08-24T00:20:25.000Z

aws-cloud9: add page #10627

Answer 40 · 2023-09-13T07:37:22.000Z

Can I work on this?

Answer 41 · 2023-09-13T07:40:49.000Z

Can I work on this?

Sure

Answer 42 · 2023-09-13T07:52:26.000Z

I am new to open source, could you please guide me? and what are the things I should follow in order to solve this issue

Answer 43 · 2023-10-24T21:11:21.000Z

I'm new. Can I help?

aws-codeartifact: add page #11224

Answer 44 · 2023-11-11T23:57:25.000Z

Hey, @Sourav-Kumar-Panda, @nkzren! You don't need to ask - just open a pull request with a new page :-)

Answer 45 · 2023-11-20T16:15:36.000Z

Update from myself: I might do some work with Sagemaker in the near future (on boto3 level), so I might document something for those items.

Answer 46 · 2023-11-22T14:29:50.000Z

Hey, @Waples , please check the PR #11570

Answer 47 · 2023-11-23T07:10:32.000Z

aws-eks: add page. #11577

Answer 48 · 2023-12-14T06:12:58.000Z

When looking at https://docs.aws.amazon.com/cli/latest/, there is a note about a new CLI version:

Note

You are viewing the documentation for an older major version of the AWS CLI (version 1).
AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here.

Should we update the pages to match the new version?

Answer 49 · 2023-12-14T09:29:03.000Z

Should we update the pages to match the new version?

Yeah, we should also check for any changed syntax and update it (if a subcommand/flag got deprecated we should mention it is only available in v1).

Answer 50 · 2023-12-18T22:46:08.000Z

Don't forget to reference this PR's number in any PRs you open @sebastiaanspeck :-)