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

docs: add docs for StorageImage #4259

Merged
merged 4 commits into from
Jul 19, 2023
Merged

docs: add docs for StorageImage #4259

merged 4 commits into from
Jul 19, 2023

Conversation

zchenwei
Copy link
Contributor

@zchenwei zchenwei commented Jul 18, 2023 •
edited
Loading

Description of changes

Add documentation for StorageImage

Issue #, if available

Description of how you validated changes

Checklist

  • Have read the Pull Request Guidelines
  • PR description included
  • Relevant documentation is changed or added (and PR referenced)
  • yarn test passes and tests are updated/added
  • No side effects or sideEffects field updated

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@changeset-bot
Copy link

changeset-bot bot commented Jul 18, 2023 •
edited
Loading

⚠️ No Changeset found

Latest commit: a968059

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

zchenwei
zchenwei commented Jul 18, 2023
View reviewed changes
docs/src/pages/[platform]/connected-components/storage/storageimage/react.mdx
At a minimum you must include the `alt`, `imgKey` and `accessLevel` props. `accessLevel` refers to the [Amplify Storage access level](https://docs.amplify.aws/lib/storage/configureaccess/q/platform/js/), which is `'public' | 'private' | 'protected'`.

<Example>
<Image alt='cat' src='/cats/1.jpg' width="400px" height="400px" />
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The existing storage mock is doing via a custom provider and it is not supported on StorageImage API. So simply use an Image to render the example.

@zchenwei zchenwei marked this pull request as ready for review July 18, 2023 19:55
@zchenwei zchenwei requested a review from a team as a code owner July 18, 2023 19:55
@zchenwei zchenwei marked this pull request as draft July 18, 2023 19:55
@zchenwei zchenwei marked this pull request as ready for review July 18, 2023 19:57
zchenwei
zchenwei commented Jul 18, 2023
View reviewed changes
Copy link
Contributor Author

@zchenwei zchenwei left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I try to deploy an app to hosting but now it requires admin access to our repo 😅

@hbuchel
Copy link
Contributor

hbuchel commented Jul 19, 2023

I try to deploy an app to hosting but now it requires admin access to our repo 😅

@zchenwei I deployed it here https://chenwz-dev-imagedocs.dvmvffzts1tcu.amplifyapp.com/ (probably still building if you are reading this just after I posted this comment though)

@zchenwei
Copy link
Contributor Author

I try to deploy an app to hosting but now it requires admin access to our repo 😅

@zchenwei I deployed it here https://chenwz-dev-imagedocs.dvmvffzts1tcu.amplifyapp.com/ (probably still building if you are reading this just after I posted this comment though)

Ohhh sweet! I ended up successfully deploying an app with hosting a few minutes ago. It is extremely hard to debug in hosting console with long logs 😭 <- https://chenwz-dev-imagedocs.daoba3qczgnpf.amplifyapp.com/react/connected-components/storage/storageimage

@hbuchel
Copy link
Contributor

hbuchel commented Jul 19, 2023

@zchenwei missing snapshot update for sitemap :) (my build failed on that)

reesscot
reesscot approved these changes Jul 19, 2023
View reviewed changes
Copy link
Contributor

@reesscot reesscot left a comment

Choose a reason for hiding this comment

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

LGTM

@zchenwei zchenwei merged commit ec0eaae into feature/storageimage Jul 19, 2023
1 check passed
@zchenwei zchenwei deleted the chenwz-dev-imagedocs branch July 19, 2023 17:27
zchenwei added a commit that referenced this pull request Jul 19, 2023
@zchenwei
chore(ui-react-storage): add docs and e2e tests for StorageImage (#4262)
aea82ff 
* test(react-storage): add e2e tests for StorageImage (#4253)

* docs: add docs for StorageImage (#4259)

* Create stale-dancers-flash.md

* test: update sitemap snapshot
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@reesscot reesscot reesscot approved these changes

@thaddmt thaddmt thaddmt approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@zchenwei @hbuchel @reesscot @thaddmt