Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Let's document: aws #5653

Open
Waples opened this issue Mar 31, 2021 · 60 comments
Open

Let's document: aws #5653

Waples opened this issue Mar 31, 2021 · 60 comments
Assignees
@Waples
Labels
good first issue Recommended issues for first-time contributors. help wanted You can help make tldr-pages better! let's document Tracker issue to document multiple subcommands/commands of a tool or utility or category. new command Issues requesting creation of a new page or PRs adding a new page for a command.

Comments

@Waples
Copy link
Member

Waples commented Mar 31, 2021 •
edited by kbdharun
Loading

@Waples
Copy link
Member Author

Waples commented Mar 31, 2021

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

@bl-ue bl-ue added help wanted You can help make tldr-pages better! new command Issues requesting creation of a new page or PRs adding a new page for a command. labels Mar 31, 2021
@bl-ue
Copy link
Contributor

bl-ue commented Mar 31, 2021

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

@bl-ue
Copy link
Contributor

bl-ue commented Mar 31, 2021

@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

@Waples
Copy link
Member Author

Waples commented Apr 1, 2021 •
edited
Loading

@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

@Waples
Copy link
Member Author

Waples commented Apr 1, 2021

Fixed it =D

@Waples
Copy link
Member Author

Waples commented Apr 1, 2021

@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.

@bl-ue
Copy link
Contributor

bl-ue commented Apr 1, 2021

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

@Waples
Copy link
Member Author

Waples commented Apr 2, 2021

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

@bl-ue
Copy link
Contributor

bl-ue commented Apr 2, 2021

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 🤷🏻

@Waples
Copy link
Member Author

Waples commented Apr 2, 2021

Organization status, here I come. xD

@Waples
Copy link
Member Author

Waples commented Apr 2, 2021

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

@bl-ue
Copy link
Contributor

bl-ue commented Apr 2, 2021

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

@sbrl
Copy link
Member

sbrl commented Apr 3, 2021

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.

@258204
Copy link
Collaborator

258204 commented Jun 16, 2021

Starting one on secrets manager now.

@258204
Copy link
Collaborator

258204 commented Jun 16, 2021

Starting s3api and cur

This was referenced Jun 16, 2021
Merged
Merged
@258204 258204 mentioned this issue Jun 16, 2021
Merged
6 tasks
@258204
Copy link
Collaborator

258204 commented Jun 17, 2021

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

@bl-ue
Copy link
Contributor

bl-ue commented Jun 17, 2021 •
edited
Loading

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! 🙂

@258204
Copy link
Collaborator

258204 commented Jun 17, 2021

I will start on ecr first then.

@258204
Copy link
Collaborator

258204 commented Jun 17, 2021

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

@258204
Copy link
Collaborator

258204 commented Jun 17, 2021

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.

@258204
Copy link
Collaborator

258204 commented Jun 17, 2021 •
edited
Loading

Also need to add a short one for docker-tag

@258204
Copy link
Collaborator

258204 commented Jun 17, 2021

And docker-image....

DOCUMENT ALL THE THINGS!!! :D

@bl-ue
Copy link
Contributor

bl-ue commented Jun 17, 2021 •
edited
Loading

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. 😅

@258204
Copy link
Collaborator

258204 commented Jun 17, 2021

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

@sbrl
Copy link
Member

sbrl commented Jun 17, 2021

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.

@bryanmg
Copy link
Contributor

bryanmg commented Oct 15, 2022

aws-sqs: add page #9085

@Waples
Copy link
Member Author

Waples commented Feb 4, 2023

Thank you @piraces @bryanmg for all your work!

@Waples
Copy link
Member Author

Waples commented Jun 19, 2023

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

@the0001
Copy link
Contributor

the0001 commented Aug 3, 2023 •
edited
Loading

First timer trying to help.

aws-batch: add page #10591

@the0001
Copy link
Contributor

the0001 commented Aug 18, 2023

aws-cloudwatch: add page #10614

@the0001
Copy link
Contributor

the0001 commented Aug 24, 2023

aws-cloud9: add page #10627

@Sourav-Kumar-Panda
Copy link
Contributor

Can I work on this?

@kbdharun
Copy link
Member

Can I work on this?

Sure

@Sourav-Kumar-Panda
Copy link
Contributor

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

@kbdharun kbdharun added the let's document Tracker issue to document multiple subcommands/commands of a tool or utility or category. label Oct 21, 2023
@nkzren
Copy link
Contributor

nkzren commented Oct 24, 2023

I'm new. Can I help?

aws-codeartifact: add page #11224

@sbrl
Copy link
Member

sbrl commented Nov 11, 2023

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

@Waples
Copy link
Member Author

Waples commented Nov 20, 2023

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.

@Sourav-Kumar-Panda
Copy link
Contributor

Hey, @Waples , please check the PR #11570

@Sourav-Kumar-Panda
Copy link
Contributor

aws-eks: add page. #11577

@sebastiaanspeck
Copy link
Member

sebastiaanspeck commented Dec 14, 2023 •
edited
Loading

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?

@kbdharun
Copy link
Member

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).

@sbrl
Copy link
Member

sbrl commented Dec 18, 2023

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

@ghost
Copy link

ghost commented Mar 11, 2024 •
edited by ghost
Loading

@Waples adding this to the aws terraform. Writing the aws terraform initator files: https://github.com/sablokgaurav/hashicorp_instance_initiator/blob/main/terraform_aws.sh for merging into the tldr pages.

@Waples
Copy link
Member Author

Waples commented May 6, 2024

Just as an FYI, I have been ill / busy for a long while, but I do still weekly check how the process is going. Thank you all for giving you're time to fill the stupidly long list of items.

I will be more aware of ongoing work / MR/PRs etc from now on again, now my health has improved (beware xD).

@sebastiaanspeck
Copy link
Member

Just as an FYI, I have been ill / busy for a long while, but I do still weekly check how the process is going. Thank you all for giving you're time to fill the stupidly long list of items.

I will be more aware of ongoing work / MR/PRs etc from now on again, now my health has improved (beware xD).

Good to have you back! :D

@Waples
Copy link
Member Author

Waples commented May 6, 2024

Just as an FYI, I have been ill / busy for a long while, but I do still weekly check how the process is going. Thank you all for giving you're time to fill the stupidly long list of items.
I will be more aware of ongoing work / MR/PRs etc from now on again, now my health has improved (beware xD).

Good to have you back! :D

thanks bruv ^^ feeling allot better now. Lets document some stuff haha

@Waples
Copy link
Member Author

Waples commented May 6, 2024

At the time of writing, I don't even know myself anymore if this list is complete and compatible with v3 (and v4-beta).

Note to self: investigate this.

And again, thank you all for helping with this massive project.

// Florian

@Waples Waples self-assigned this May 6, 2024
@sebastiaanspeck sebastiaanspeck mentioned this issue Jul 30, 2024
Merged
5 tasks
@skarkloff
Copy link

Good morning, I am new to open source contributions. I saw this project and I am interested in contributing, how can I get started, whether for this issue or another?

@spageektti
Copy link
Member

spageektti commented Aug 5, 2024 •
edited
Loading

Good morning, I am new to open source contributions. I saw this project and I am interested in contributing, how can I get started, whether for this issue or another?

Read CONTRIBUTING.md and Style Guide. This will make it easier both for you and maintainers.

If you speak lang other than English, consider translating the pages, it's the most easy way to get started.

Consider adding examples to existing pages to practice before creating new pages, but creating a new page is welcome too.

Check this tutorial to learn GitHub and Git.

@sebastiaanspeck sebastiaanspeck unpinned this issue Sep 10, 2024
@phantompunk
Copy link
Contributor

aws-sso: add page #14115

@sebastiaanspeck
Copy link
Member

aws-sso: add page #14115

Thanks! Added to the list

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Waples Waples

Labels
good first issue Recommended issues for first-time contributors. help wanted You can help make tldr-pages better! let's document Tracker issue to document multiple subcommands/commands of a tool or utility or category. new command Issues requesting creation of a new page or PRs adding a new page for a command.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests