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

Put docs back in this repository #278

Merged
merged 5 commits into from
Nov 26, 2024
Merged

Put docs back in this repository #278

merged 5 commits into from
Nov 26, 2024

Conversation

Murderlon
Copy link
Member

@Murderlon Murderlon commented Nov 26, 2024

We tried an experiment where we put the docs inside the uppy repository so we can version them with releases and run some commands in this repository to get the latest version tag and download those docs.

This became significantly more tedious than it's worth

  • You can't live preview your doc changes anymore
  • If you do want that, you have to create a new branch in uppy and push your changes. Then you have to manually change the downloadDocs command to point to your branch. For every change in the other repository, you have to go back here and run that again.
  • It gets worse when you are using MDX components inside the docs because the components still live here, making the point above even harder again.
  • Linting gets out of sync. It may pass locally in uppy, but then in fails in CI as it tries to run the linting from this repository.

Let's put it back.

Ref: transloadit/uppy#5527

@Murderlon Murderlon requested a review from mifi November 26, 2024 08:36
@Murderlon Murderlon self-assigned this Nov 26, 2024
@Murderlon Murderlon merged commit df47139 into main Nov 26, 2024
1 of 2 checks passed
@Murderlon Murderlon deleted the bring-back-docs branch November 26, 2024 09:33
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.

1 participant