docs: add back markdown files #5064
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Diff output filesNo diff |
|
how to develop/preview docs locally now? i don't see any |
|
I see there is now CI to see if the build succeeds, but it would be great if we can do a PR preview. While there may not be syntax errors, MDX can produced unexpected results sometimes in terms of how it looks. It would be good to catch that before it's live. I think we already have a Transloadit Netlify account, so it should be easy to add. |
Nothing changes on that front, you use the same |
|
can't we move all of uppy.io back into uppy? or else we'll have a disconnect between uppy.io build tooling and the markdown |
No, that sounds like a bad DX (contributors would have to download GBs of useless dependencies if they want to fix a simple bug), we moved the website tooling to its own repo for a good reason.
That seems like a better tradeoff than the current situation, where we have a disconnect between the docs and the code. |
|
In general I would avoid disconnecting code from its dependencies, but I guess in this case it's an ok compromise because a working documentation is not as important as working code. |
Merged
github-actions bot
added a commit
that referenced
this pull request
Apr 16, 2024
| Package | Version | Package | Version | | --------------- | ------- | --------------- | ------- | | @uppy/dashboard | 3.8.1 | uppy | 3.24.3 | | @uppy/utils | 5.8.0 | | | - docs: add back markdown files (Antoine du Hamel / #5064) - meta: fix custom provider example (Merlijn Vos / #5079) - @uppy/utils: add fetcher (Merlijn Vos / #5073) - meta: Fix prettier (Murderlon) - @uppy/dashboard: add missing `x-zip-compress` archive type (Younes / #5081) - meta: Bump docker/metadata-action from 4 to 5 (dependabot[bot] / #5086) - meta: Bump actions/setup-node from 3 to 4 (dependabot[bot] / #5087) - meta: Bump docker/setup-qemu-action from 2 to 3 (dependabot[bot] / #5089) - meta: bump supercharge/redis-github-action from 1.4.0 to 1.8.0 (dependabot[bot] / #5090) - meta: bump actions/cache from 3 to 4 (dependabot[bot] / #5088) - meta: add `dependabot.yml` to keep GHA up-to-date (Antoine du Hamel / #5083)
actually when i think more about it, users already have to download GBs of useless companion dependencies even if they want to fix a simple Uppy bug (that doesn't involve companion for example). However doesn't yarn workspace already solve this problem? e.g. |
Murderlon
added a commit
that referenced
this pull request
Apr 17, 2024
* 4.x: (34 commits) Release: uppy@3.24.3 (#5091) docs: add back markdown files (#5064) meta: fix custom provider example (#5079) @uppy/utils: add fetcher (#5073) Fix prettier @uppy/dashboard: add missing `x-zip-compress` archive type (#5081) Bump docker/metadata-action from 4 to 5 (#5086) Bump actions/setup-node from 3 to 4 (#5087) Bump docker/setup-qemu-action from 2 to 3 (#5089) meta: bump supercharge/redis-github-action from 1.4.0 to 1.8.0 (#5090) meta: bump actions/cache from 3 to 4 (#5088) Release: uppy@4.0.0-beta.3 (#5085) meta: add `dependabot.yml` to keep GHA up-to-date (#5083) Release: uppy@3.24.2 (#5084) @uppy/core: fix `setOptions` not re-rendereing plugin UI (#5082) Release: uppy@4.0.0-beta.2 (#5077) @uppy/aws-s3: default to multipart depending on the size of input (#5076) @uppy/aws-s3: remove deprecated `prepareUploadParts` option (#5075) fixup! @uppy/core: use variadic arguments for `uppy.use` (#4888) @uppy/core: use variadic arguments for `uppy.use` (#4888) ...
Murderlon
added a commit
that referenced
this pull request
Apr 23, 2024
* main: @uppy/form: fix `submitOnSuccess` and `triggerUploadOnSubmit` combination (#5058) Bump docker/build-push-action from 3 to 5 (#5105) Bump akhileshns/heroku-deploy from 3.12.12 to 3.13.15 (#5102) Bump docker/login-action from 2 to 3 (#5101) Bump actions/download-artifact from 3 to 4 Bump actions/upload-artifact from 3 to 4 Release: uppy@3.24.3 (#5091) docs: add back markdown files (#5064) meta: fix custom provider example (#5079)
This was referenced Apr 29, 2024
github-actions bot
added a commit
that referenced
this pull request
Apr 29, 2024
| Package | Version | Package | Version | | ---------------------- | ------------ | ---------------------- | ------------ | | @uppy/angular | 0.7.0-beta.4 | @uppy/instagram | 4.0.0-beta.4 | | @uppy/audio | 2.0.0-beta.4 | @uppy/onedrive | 4.0.0-beta.4 | | @uppy/aws-s3-multipart | 4.0.0-beta.4 | @uppy/provider-views | 4.0.0-beta.4 | | @uppy/box | 3.0.0-beta.4 | @uppy/react | 4.0.0-beta.4 | | @uppy/companion | 5.0.0-beta.4 | @uppy/status-bar | 4.0.0-beta.4 | | @uppy/companion-client | 4.0.0-beta.4 | @uppy/store-redux | 4.0.0-beta.2 | | @uppy/compressor | 2.0.0-beta.4 | @uppy/svelte | 4.0.0-beta.2 | | @uppy/core | 4.0.0-beta.4 | @uppy/transloadit | 4.0.0-beta.4 | | @uppy/dashboard | 4.0.0-beta.4 | @uppy/unsplash | 4.0.0-beta.4 | | @uppy/drop-target | 3.0.0-beta.4 | @uppy/url | 4.0.0-beta.4 | | @uppy/dropbox | 4.0.0-beta.4 | @uppy/utils | 6.0.0-beta.4 | | @uppy/facebook | 4.0.0-beta.4 | @uppy/webcam | 4.0.0-beta.4 | | @uppy/file-input | 4.0.0-beta.4 | @uppy/xhr-upload | 4.0.0-beta.2 | | @uppy/form | 4.0.0-beta.2 | @uppy/zoom | 3.0.0-beta.4 | | @uppy/google-drive | 4.0.0-beta.4 | uppy | 4.0.0-beta.4 | | @uppy/image-editor | 3.0.0-beta.2 | | | - meta: Upgrade Yarn to 4.x (Merlijn Vos / #4849) - @uppy/utils: fix fetcher export (Murderlon) - @uppy/xhr-upload: refactor to use `fetcher` (Merlijn Vos / #5074) - docs: use StackBlitz for all examples/issue template (Merlijn Vos / #5125) - meta: Update yarn.lock (Murderlon) - @uppy/svelte: Add svelte 5 as peer dep (frederikhors / #5122) - meta: Bump docker/setup-buildx-action from 2 to 3 (dependabot[bot] / #5124) - meta: Bump actions/checkout from 3 to 4 (dependabot[bot] / #5123) - @uppy/dashboard,@uppy/provider-views: Remove JSX global type everywhere (Merlijn Vos / #5117) - @uppy/utils: improve return type of `dataURItoFile` (Antoine du Hamel / #5112) - @uppy/drop-target: change drop event type to DragEvent (Alireza Heydari / #5107) - @uppy/image-editor: fix label definitions (Antoine du Hamel / #5111) - meta: bump Prettier version (Antoine du Hamel / #5114) - @uppy/provider-views: bring back "loaded X files..." (Mikael Finstad / #5097) - @uppy/dashboard: fix type of trigger option (Merlijn Vos / #5106) - meta: fix linter (Antoine du Hamel) - @uppy/companion: bump Node.js version support matrix (Antoine du Hamel / #5035) - @uppy/form: fix `submitOnSuccess` and `triggerUploadOnSubmit` combination (Merlijn Vos / #5058) - meta: Bump docker/build-push-action from 3 to 5 (dependabot[bot] / #5105) - meta: Bump akhileshns/heroku-deploy from 3.12.12 to 3.13.15 (dependabot[bot] / #5102) - meta: Bump docker/login-action from 2 to 3 (dependabot[bot] / #5101) - meta: Bump actions/download-artifact from 3 to 4 (dependabot[bot]) - meta: Bump actions/upload-artifact from 3 to 4 (dependabot[bot]) - @uppy/react: remove `useUppy` & reintroduce `useUppyState` (Merlijn Vos / #5059) - meta: docs: add back markdown files (Antoine du Hamel / #5064) - meta: fix custom provider example (Merlijn Vos / #5079) - @uppy/utils: add fetcher (Merlijn Vos / #5073) - meta: Fix prettier (Murderlon) - @uppy/dashboard: add missing `x-zip-compress` archive type (Younes / #5081) - meta: Bump docker/metadata-action from 4 to 5 (dependabot[bot] / #5086) - meta: Bump actions/setup-node from 3 to 4 (dependabot[bot] / #5087) - meta: Bump docker/setup-qemu-action from 2 to 3 (dependabot[bot] / #5089) - meta: bump supercharge/redis-github-action from 1.4.0 to 1.8.0 (dependabot[bot] / #5090) - meta: bump actions/cache from 3 to 4 (dependabot[bot] / #5088) - meta: add `dependabot.yml` to keep GHA up-to-date (Antoine du Hamel / #5083) - @uppy/core: Release: uppy@3.24.2 (github-actions[bot] / #5084) - @uppy/core: fix `setOptions` not re-rendereing plugin UI (Antoine du Hamel / #5082) - meta: bump vite from 5.0.12 to 5.0.13 (dependabot[bot] / #5060) - meta: bump tar from 6.1.11 to 6.2.1 (dependabot[bot] / #5068) - @uppy/companion,@uppy/file-input: Release: uppy@3.24.1 (github-actions[bot] / #5069) - @uppy/companion: upgrade redis (Mikael Finstad / #5065) - meta: fix `watch:*` scripts (Antoine du Hamel / #5046) - meta: include more packages in `compare_diff` CI (Antoine du Hamel / #5044) - @uppy/file-input: add missing export (Antoine du Hamel / #5045) - meta: Bump express from 4.18.1 to 4.19.2 in /packages/@uppy/companion (dependabot[bot] / #5036) - @uppy/companion: Bump express from 4.18.1 to 4.19.2 (dependabot[bot] / #5037) | Package | Version | Package | Version | | ---------------------- | ------- | ---------------------- | ------- | | @uppy/audio | 1.1.9 | @uppy/instagram | 3.3.1 | | @uppy/aws-s3-multipart | 3.11.1 | @uppy/onedrive | 3.3.1 | | @uppy/box | 2.3.1 | @uppy/provider-views | 3.12.0 | | @uppy/companion-client | 3.8.1 | @uppy/react | 3.3.1 | | @uppy/compressor | 1.1.3 | @uppy/status-bar | 3.3.2 | | @uppy/core | 3.11.0 | @uppy/svelte | 3.1.4 | | @uppy/dashboard | 3.8.2 | @uppy/transloadit | 3.6.1 | | @uppy/drop-target | 2.1.0 | @uppy/unsplash | 3.3.1 | | @uppy/dropbox | 3.3.1 | @uppy/url | 3.6.1 | | @uppy/facebook | 3.3.1 | @uppy/utils | 5.9.0 | | @uppy/file-input | 3.1.2 | @uppy/webcam | 3.4.1 | | @uppy/form | 3.2.1 | @uppy/xhr-upload | 3.6.5 | | @uppy/google-drive | 3.5.1 | @uppy/zoom | 2.3.1 | | @uppy/image-editor | 2.4.5 | uppy | 3.25.0 | - meta: enforce use of `.js` extension in `import type` declarations (Antoine du Hamel / #5126) - @uppy/core: add instance ID to generated IDs (Merlijn Vos / #5080) - @uppy/core: reference updated i18n in Restricter (Merlijn Vos / #5118) - @uppy/xhr-upload: refactor to use `fetcher` (Merlijn Vos / #5074) - meta: docs: use StackBlitz for all examples/issue template (Merlijn Vos / #5125) - meta: Update yarn.lock (Murderlon) - @uppy/svelte: Add svelte 5 as peer dep (frederikhors / #5122) - meta: Bump docker/setup-buildx-action from 2 to 3 (dependabot[bot] / #5124) - meta: Bump actions/checkout from 3 to 4 (dependabot[bot] / #5123) - @uppy/dashboard,@uppy/provider-views: Remove JSX global type everywhere (Merlijn Vos / #5117) - @uppy/utils: improve return type of `dataURItoFile` (Antoine du Hamel / #5112) - @uppy/drop-target: change drop event type to DragEvent (Alireza Heydari / #5107) - @uppy/image-editor: fix label definitions (Antoine du Hamel / #5111) - meta: bump Prettier version (Antoine du Hamel / #5114) - @uppy/provider-views: bring back "loaded X files..." (Mikael Finstad / #5097) - @uppy/dashboard: fix type of trigger option (Merlijn Vos / #5106) - meta: fix linter (Antoine du Hamel) - @uppy/form: fix `submitOnSuccess` and `triggerUploadOnSubmit` combination (Merlijn Vos / #5058) - meta: Bump docker/build-push-action from 3 to 5 (dependabot[bot] / #5105) - meta: Bump akhileshns/heroku-deploy from 3.12.12 to 3.13.15 (dependabot[bot] / #5102) - meta: Bump docker/login-action from 2 to 3 (dependabot[bot] / #5101) - meta: Bump actions/download-artifact from 3 to 4 (dependabot[bot]) - meta: Bump actions/upload-artifact from 3 to 4 (dependabot[bot])
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Move back the documentation to the Uppy repo. Having a separate repo for the website tooling is great, but having the Markdown/MDX documents on a separate repo causes friction, especially with the upcoming 4.0.0 release. This PR moves back those files in this repo, the other repo will use this repo as the source of truth to generate the docs on the website.
We have a cron workflow on uppy/uppy.io that opens a PR every time we release a new Uppy version, the website would get updated when that PR lands.