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.

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

aws-s3-website: add page #11642

Merged
merged 7 commits into from
Dec 3, 2023
Merged

aws-s3-website: add page #11642

merged 7 commits into from
Dec 3, 2023

Conversation

Isaac-Carrascal
Copy link
Contributor

Add an initial description of the local options for aws s3 website command.

  • 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): j

Add an initial description of the local options for aws s3 website command.
@github-actions github-actions bot added the new command Issues requesting creation of a new page or PRs adding a new page for a command. label Dec 2, 2023
@tldr-bot

This comment was marked as resolved.

@kbdharun kbdharun mentioned this pull request Dec 2, 2023
11 tasks
Copy link
Member

@kbdharun kbdharun left a comment

Choose a reason for hiding this comment

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

Welcome to tldr and thanks for your contribution. I have some suggestions for this page.

Isaac-Carrascal and others added 2 commits December 2, 2023 18:01
@Isaac-Carrascal
Copy link
Contributor Author

Welcome to tldr and thanks for your contribution. I have some suggestions for this page.

Thanks for your suggestions. Looking forward to continue contributing to this great project.

@kbdharun
Copy link
Member

kbdharun commented Dec 3, 2023

@Isaac-Carrascal Was this PR accidentally closed?

@Isaac-Carrascal
Copy link
Contributor Author

Isaac-Carrascal commented Dec 3, 2023

@kbdharun Oops, sorry. I am new to this. Should I keep it open? I thought the change was made. What I should do?

@kbdharun
Copy link
Member

kbdharun commented Dec 3, 2023

Oops, sorry. I am new to this. Should I keep it open? I thought the change was made. What I should do?

No issues, you can click on the Reopen button below the comment box to reopen this PR (pull request).

image

Edit. Great

Comment on lines 7 to 13
- Configure a bucket as a static website:

`aws s3 website {{s3://bucket-name/}} --index-document {{index.html}}`

- Configure an error page for the website:

`aws s3 website {{s3://bucket-name/}} --index-document {{index.html}} --error-document {{error.html}}`
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
- Configure a bucket as a static website:
`aws s3 website {{s3://bucket-name/}} --index-document {{index.html}}`
- Configure an error page for the website:
`aws s3 website {{s3://bucket-name/}} --index-document {{index.html}} --error-document {{error.html}}`
- Configure a bucket as a static website:
`aws s3 website {{s3://bucket-name/}} --index-document {{path/to/index.html}}`
- Configure an error page for the website:
`aws s3 website {{s3://bucket-name/}} --index-document {{path/to/index.html}} --error-document {{path/to/error.html}}`

I know nothing about s3, but I suspect that the command expects a file path in the specified locations. Is that correct? If that's the case, we can spell it out in the tldr page.

Copy link
Member

Choose a reason for hiding this comment

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

In this case, I am pretty sure it doesn't require path, will manually check it and get back.

Copy link
Member

Choose a reason for hiding this comment

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

Yep, passing the path to this command will not work. It's been a while since I used AWS (so I had to do a quick test in the cloud shell).

image

Copy link
Member

Choose a reason for hiding this comment

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

For bucket name, we don't need a trailing backslash, other than that, this PR is GTG.

Suggested change
- Configure a bucket as a static website:
`aws s3 website {{s3://bucket-name/}} --index-document {{index.html}}`
- Configure an error page for the website:
`aws s3 website {{s3://bucket-name/}} --index-document {{index.html}} --error-document {{error.html}}`
- Configure a bucket as a static website:
`aws s3 website {{s3://bucket-name}} --index-document {{index.html}}`
- Configure an error page for the website:
`aws s3 website {{s3://bucket-name}} --index-document {{index.html}} --error-document {{error.html}}`

Copy link
Member

@sebastiaanspeck sebastiaanspeck left a comment

Choose a reason for hiding this comment

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

LGTM, after the suggestion

@kbdharun kbdharun merged commit 3911afa into tldr-pages:main Dec 3, 2023
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants