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

docs: StorageManager prop corrections #5543

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

EthanRBrown
Copy link

Description of changes

Corrected the type of the file argument of tthe processFile callback in StorageManager: it was listed as Blob, and should be File.

Also updated CONTRIBUTING.md to add the necessary yarn install step and explained why nvm use is valuable.

Description of how you validated changes

I was not actually able to build or run the docs; the instructions in the Local Development Guides are insufficient. I waded through many issues, but finally had to give up for now...I'll take a look at that another time and if I fix it, I'll submit a PR for that doc update.

Checklist

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

@EthanRBrown EthanRBrown requested a review from a team as a code owner August 7, 2024 00:02
Copy link

changeset-bot bot commented Aug 7, 2024

⚠️ No Changeset found

Latest commit: 2d5453b

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

dbanksdesign
dbanksdesign previously approved these changes Aug 8, 2024
Copy link
Contributor

@dbanksdesign dbanksdesign left a comment

Choose a reason for hiding this comment

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

LGTM!

CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Contributor

@esauerbo esauerbo left a comment

Choose a reason for hiding this comment

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

Left one comment but otherwise LGTM. Thanks for contributing!

@EthanRBrown EthanRBrown force-pushed the docs/storage-manager-corrections branch from 9370826 to c57132b Compare August 29, 2024 17:24
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.

3 participants