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: update @uppy/aws-s3 docs #5093

Merged
merged 1 commit into from
May 16, 2024
Merged

docs: update @uppy/aws-s3 docs #5093

merged 1 commit into from
May 16, 2024

Conversation

aduh95
Copy link
Contributor

@aduh95 aduh95 commented Apr 16, 2024

Refs: #5076
Refs: #5075
Refs: #5070

@aduh95 aduh95 added the 4.0 For the 4.0 major version label Apr 16, 2024
@aduh95 aduh95 requested a review from Murderlon April 16, 2024 15:36
Copy link
Contributor

Diff output files
No diff

Copy link
Member

@Murderlon Murderlon left a comment

Choose a reason for hiding this comment

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

It's the wrong way around, aws-s3-multipart docs should move into aws-s3 and aws-s3-multipart should be removed?

@@ -41,7 +41,7 @@ milliseconds on uploading.

**In short**

- We recommend to set [`shouldUseMultipart`][] to enable multipart uploads only
- We recommend the default value of [`shouldUseMultipart`][], which enable multipart uploads only
for large files.
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
for large files.
for large files (100 MiB).

@aduh95 aduh95 merged commit 89bfe23 into 4.x May 16, 2024
15 of 20 checks passed
@aduh95 aduh95 deleted the aws-plugin-docs-bc branch May 16, 2024 07:09
@Murderlon
Copy link
Member

It's the wrong way around, aws-s3-multipart docs should move into aws-s3 and aws-s3-multipart should be removed?

What about this?

@aduh95
Copy link
Contributor Author

aduh95 commented May 16, 2024

I don't know if it's worth breaking the existing links. In any case, that can always happen in a follow-up PR, but hopefully we can agree this PR is better merged than not

@Murderlon
Copy link
Member

I won't break links on the website, we can ensure that. If people have GitHub files bookmarked I don't care about breaking those.

Murderlon added a commit that referenced this pull request May 21, 2024
* 4.x: (24 commits)
  @uppy/companion: encode `uploadId` (#5168)
  @uppy/companion: bump `express-session` (#5177)
  @uppy/companion: remove dependency on `express-request-id` (#5176)
  @uppy/companion: bump prom to v15 (#5175)
  docs: fix linter
  meta: remove `nodemon` from the deps (#5172)
  docs: update `@uppy/aws-s3` docs (#5093)
  meta: update more dependencies (#5171)
  @uppy/companion: upgrade deps (#5119)
  Release: uppy@4.0.0-beta.7 (#5162)
  @uppy/companion: switch from `node-redis` to `ioredis` (#4623)
  Fix headings in xhr.mdx
  @uppy/xhr-upload: introduce hooks similar to tus (#5094)
  @uppy/core: close->destroy, clearUploadedFiles->clear (#5154)
  Use `title` consistently from locales (#5134)
  Release: uppy@4.0.0-beta.6 (#5152)
  Release: uppy@4.0.0-beta.5 (#5141)
  meta: run Prettier in the release workflow
  Release: uppy@3.25.1 (#5139)
  Bump ejs from 3.1.9 to 3.1.10 (#5135)
  ...
github-actions bot added a commit that referenced this pull request May 22, 2024
| Package              |      Version | Package              |      Version |
| -------------------- | ------------ | -------------------- | ------------ |
| @uppy/aws-s3         | 4.0.0-beta.4 | @uppy/status-bar     | 4.0.0-beta.8 |
| @uppy/companion      | 5.0.0-beta.7 | @uppy/svelte         | 4.0.0-beta.4 |
| @uppy/compressor     | 2.0.0-beta.8 | @uppy/tus            | 4.0.0-beta.5 |
| @uppy/core           | 4.0.0-beta.8 | @uppy/utils          | 6.0.0-beta.7 |
| @uppy/dashboard      | 4.0.0-beta.8 | @uppy/vue            | 2.0.0-beta.3 |
| @uppy/image-editor   | 3.0.0-beta.5 | @uppy/webcam         | 4.0.0-beta.7 |
| @uppy/provider-views | 4.0.0-beta.6 | uppy                 | 4.0.0-beta.8 |

- @uppy/core: resolve some (breaking) TODOs (Antoine du Hamel / #4824)
- @uppy/companion: encode `uploadId` (Mikael Finstad / #5168)
- @uppy/companion: bump `express-session` (Antoine du Hamel / #5177)
- @uppy/companion: remove dependency on `express-request-id` (Antoine du Hamel / #5176)
- @uppy/companion: bump prom to v15 (Antoine du Hamel / #5175)
- docs: fix linter (Antoine du Hamel)
- meta: remove `nodemon` from the deps (Antoine du Hamel / #5172)
- docs: update `@uppy/aws-s3` docs (Antoine du Hamel / #5093)
- meta: update more dependencies (Antoine du Hamel / #5171)
- @uppy/companion: upgrade deps (Antoine du Hamel / #5119)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4.0 For the 4.0 major version
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants