From abdf2afe86377b80be6f67fed4e0428b6d351ff4 Mon Sep 17 00:00:00 2001 From: Dev-Arhaan <113898488+Dev-Arhaan@users.noreply.github.com> Date: Thu, 13 Jul 2023 19:02:53 +0530 Subject: [PATCH 1/3] Update quickstart.md, added new 4th step making it 5 step documentation Added pnpm filtering command to restrict commands to `@openverse/eslint-plugin` as new 4th step --- documentation/frontend/guides/quickstart.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/documentation/frontend/guides/quickstart.md b/documentation/frontend/guides/quickstart.md index 8e3ee0edfe3..29e64febc4f 100644 --- a/documentation/frontend/guides/quickstart.md +++ b/documentation/frontend/guides/quickstart.md @@ -37,8 +37,18 @@ you need to run this. ```console $ just node-install ``` - -4. To bring up the frontend, we have another `just` recipe. We have `just` + +4. Filtering allows you to restrict commands to specific subsets of packages. + You might want to try Filtering to compile just the Openverse ESLint plugin. + ```console + $ pnpm --filter='@openverse/eslint-plugin' build + ``` + Or + ```console + $ pnpm --F '@openverse/eslint-plugin' build + ``` + +5. To bring up the frontend, we have another `just` recipe. We have `just` recipes for almost everything. ```console From 3909e0545f3003d8e548600f26449794c0a7e306 Mon Sep 17 00:00:00 2001 From: Krystle Salazar Date: Thu, 13 Jul 2023 20:18:56 -0400 Subject: [PATCH 2/3] Fix format --- documentation/frontend/guides/quickstart.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/documentation/frontend/guides/quickstart.md b/documentation/frontend/guides/quickstart.md index 29e64febc4f..840ab680e7c 100644 --- a/documentation/frontend/guides/quickstart.md +++ b/documentation/frontend/guides/quickstart.md @@ -37,17 +37,20 @@ you need to run this. ```console $ just node-install ``` - + 4. Filtering allows you to restrict commands to specific subsets of packages. You might want to try Filtering to compile just the Openverse ESLint plugin. + ```console $ pnpm --filter='@openverse/eslint-plugin' build ``` - Or + + Or + ```console $ pnpm --F '@openverse/eslint-plugin' build ``` - + 5. To bring up the frontend, we have another `just` recipe. We have `just` recipes for almost everything. From 67114f58313dd8fbeff882920c35c7d868829697 Mon Sep 17 00:00:00 2001 From: Arhaan Sayeed Date: Fri, 14 Jul 2023 07:57:55 +0530 Subject: [PATCH 3/3] Updated quickstart.md Modified for clarity changed flag option and 4th step description for better understanding --- documentation/frontend/guides/quickstart.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/documentation/frontend/guides/quickstart.md b/documentation/frontend/guides/quickstart.md index 840ab680e7c..6b967909b05 100644 --- a/documentation/frontend/guides/quickstart.md +++ b/documentation/frontend/guides/quickstart.md @@ -38,8 +38,7 @@ you need to run this. $ just node-install ``` -4. Filtering allows you to restrict commands to specific subsets of packages. - You might want to try Filtering to compile just the Openverse ESLint plugin. +4. If you encounter errors after this, you may need to compile just the Openverse ESLint plugin. ```console $ pnpm --filter='@openverse/eslint-plugin' build @@ -48,7 +47,7 @@ you need to run this. Or ```console - $ pnpm --F '@openverse/eslint-plugin' build + $ pnpm -F '@openverse/eslint-plugin' build ``` 5. To bring up the frontend, we have another `just` recipe. We have `just`