From 6c30c24ecbeeb89c2613548674b9acf33cd1d04b Mon Sep 17 00:00:00 2001 From: Evgenia Karunus Date: Wed, 15 May 2024 17:45:13 +0400 Subject: [PATCH 1/2] README.md - add explanation of uppy.io/docs VS uppy.io/blog --- README.md | 45 +++++++++++++++++++++++++++++++++++++++------ 1 file changed, 39 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d063b4b01..c62e840fe 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,32 @@ # Uppy.io -Website and documentation for [uppy](https://uppy.io/). +Website and documentation for [uppy.io](https://uppy.io). -This website is built using [Docusaurus 2](https://docusaurus.io/), a modern -static website generator. +Code for [uppy.io/blog](https://uppy.io/blog) lives in this repo. +Code for [uppy.io/docs](https://uppy.io/docs/quick-start) lives in +[github.com/transloadit/uppy](https://github.com/transloadit/uppy). ## Developer guide -### Installation +If you want to edit [uppy.io/blog](https://uppy.io/blog), just edit the files in +this repo. + +If you want to edit [uppy.io/docs](https://uppy.io/docs/quick-start), then you +should: + +1. Clone both the **uppy** repo and **uppy.io** repo. + +2. Then, from your **/uppy.io** repo, run: + + ```sh + ln -s /path-to-your-uppy-repo/docs docs + ``` + + Now, treat **/uppy/docs** as your working directory, but run the build/lint + scripts from your **/uppy.io** directory - **/uppy.io** will pick up your + changes. + +### Install Dependencies ```sh corepack yarn @@ -19,8 +38,17 @@ corepack yarn corepack yarn dev ``` -This command starts a local development server and opens up a browser window. -Most changes are reflected live without having to restart the server. +This command builds **/uppy/docs** and **/uppy.io**, and shows them in a +browser. Most changes are reflected live without having to restart the server. + +### Lint + +```sh +corepack yarn run format +corepack yarn lint +``` + +This command lints **/uppy/docs** and **/uppy.io**. ### Build @@ -30,3 +58,8 @@ corepack yarn build This command generates static content into the `build` directory and can be served using any static contents hosting service. + +--- + +This website is built using [Docusaurus 2](https://docusaurus.io/), a modern +static website generator. From f70cb4af078615f62d83e6a57aff4e7f6beb217f Mon Sep 17 00:00:00 2001 From: Evgenia Karunus Date: Tue, 21 May 2024 19:35:09 +0400 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Antoine du Hamel --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c62e840fe..bd3574702 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ should: 1. Clone both the **uppy** repo and **uppy.io** repo. -2. Then, from your **/uppy.io** repo, run: +2. Then, from your `uppy.io` clone, run: ```sh ln -s /path-to-your-uppy-repo/docs docs