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

chore(docs): add StorageBrowser amplify auth note #6342

Merged
merged 1 commit into from
Feb 11, 2025

Conversation

calebpollman
Copy link
Member

Description of changes

  • add note regarding placement of Amplify.configure call in StorageBrowser Amplify Auth example
  • update docs StorageBrowser example declaration from MockStorageBrowser.ts to StorageBrowser.ts to remove "Mock" references in documentation

Issue #, if available

NA

Description of how you validated changes

yarn docs dev

Checklist

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

@calebpollman calebpollman requested a review from a team as a code owner February 10, 2025 23:51
Copy link

changeset-bot bot commented Feb 10, 2025

⚠️ No Changeset found

Latest commit: 2405f70

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

@@ -130,6 +130,7 @@ import "@aws-amplify/ui-react-storage/styles.css";

import config from './amplify_outputs.json';

// note: `Amplify.configure` must be run before call to `createAmplifyAuthAdapter`
Copy link
Member

Choose a reason for hiding this comment

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

Nit: should surrounding text in the Amplify Auth section of the docs further highlight this, or should this callout in the code be sufficient?

@calebpollman calebpollman merged commit 77e885e into main Feb 11, 2025
37 checks passed
@calebpollman calebpollman deleted the docs/update-sto-bro-amplify-adapter branch February 11, 2025 00:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants