javascript icon indicating copy to clipboard operation
javascript copied to clipboard

Missing documentation monorepo

Open LisanneKluitmans opened this issue 6 years ago • 0 comments

Explanation

Bestaand: https://github.com/Yoast/javascript/blob/develop/README.md

Outdated: https://github.com/Yoast/Wiki/wiki/How-to-build-a-local-version-of-a-plugin-with-the-new-monorepo

Link informatie moet worden geüpdated en uitgebreid met de unlink informatie Die link informatie is min of meer dit:

  1. git clone https://github.com/yoast/javascript where you want to manage your monorepo code. (e.g. ~/dev)
  2. yarn link-monorepo in the Yoast SEO root dir.
  3. You’ll be prompted for an absolute or relative path to the JS clone. In the case of the example that’d be /Users/yourusername/dev/javascript (Node does not support paths with ~) or ../javascript if your YoastSEO is located in ~/dev/wordpress-seo. It doesn’t really matter which one you pick (absolute or relative) Dit moet worden uitgebreid met informatie hoe je de juiste branch kan kiezen (dus dat je in de javascript monorepo die branch moet uitchecken) Er was ook nog onduidelijkheid of er nog een grunt build in de monorepo moet worden gedaan - graag erbij zetten of dat nodig is of niet

Voor de volledigheid ook uitbreiden met informatie over hoe je kan zien wat er gelinked staat, dus: Command to view all linked packages, including @yoast packages: { ls -l node_modules | grep ^l & ls -al node_modules/@yoast | grep ^l }

Vragen waarvan ik de antwoorden gedocumenteerd zou willen hebben: Als ik als dev een dependency wil toevoegen, moet ik dat dan in de specifieke package doen of in de root? Wat zijn bepalende factoren hierin? Hierop aansluitend (en wellicht hetzelfde antwoord): Als ik een dependency wil updaten (bijv. vanwege een github security alert), waar moet ik dan de yarn why en yarn upgrade doen? In de package zelf of in de root?

Technical decisions

Feedback?

LisanneKluitmans avatar Jun 05 '19 11:06 LisanneKluitmans