Skip to content

aws-s3-sync: add page; aws-s3: update page #10898

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.

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

Closed

Conversation

geovanaSouza
Copy link

@geovanaSouza geovanaSouza commented Oct 8, 2023

This PR addresses #8406

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page(s) have at most 8 examples.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known):

The modifications to pages/common/aws-s3-sync.md and pages/common/aws-s3.md were made in this same MR because I moved some commands related to sync that were already described in pages/common/ aws-s3.md and then pages/common/aws-s3.md was left with only few examples after this change.

So I decided to add some missing examples that would make sense to be in pages/common/aws-s3.md to keep an adequate number of examples in the main command file.

I hope there are no problems with this. If you think it's better to segregate it into 2 PRs, let me know and I'll make the change.

image image

@CLAassistant
Copy link

CLAassistant commented Oct 8, 2023

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ sebastiaanspeck
❌ geovanapsouza
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions github-actions bot added new command Issues requesting creation of a new page or PRs adding a new page for a command. page edit Changes to an existing page(s). labels Oct 8, 2023
@tldr-bot
Copy link

tldr-bot commented Oct 8, 2023

The build for this PR failed with the following error(s):

pages/common/aws-s3-sync.md:3: TLDR004 Command descriptions should end in a period

Please fix the error(s) and push again.

@geovanaSouza geovanaSouza changed the title Docs/aws s3 sync add page aws-s3-sync: add page and aws-s3: add include, exclude and help examples Oct 8, 2023
@kbdharun kbdharun changed the title aws-s3-sync: add page and aws-s3: add include, exclude and help examples aws-s3-sync: add page; aws-s3: update page Oct 9, 2023
@geovanaSouza geovanaSouza marked this pull request as draft October 9, 2023 11:28
@sebastiaanspeck
Copy link
Member

Any update on this?

Copy link
Member

@gutjuri gutjuri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello, thanks for your contribution. I think it is fine to have this in one PR. I have added one minor suggestion (typo). Apart from that, LGTM. Also, could you please sign the CLA? Otherwise we cannot merge this PR.

> More information: <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3/index.html>.

- Show files in a bucket:

`aws s3 ls {{bucket_name}}`

- Sync files and directories from local to bucket:
- Filter the included or excluded files, directory, objects or extension that will be manipuled in the operations:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Filter the included or excluded files, directory, objects or extension that will be manipuled in the operations:
- Filter the included or excluded files, directory, objects or extension that will be manipulated in the operations:

@sebastiaanspeck
Copy link
Member

Any update on this draft PR @geovanaSouza?

@gutjuri gutjuri mentioned this pull request Nov 29, 2023
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page or PRs adding a new page for a command. page edit Changes to an existing page(s).
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants