Add document explaing how to make changes and view them locally #158
Conversation
erikphansen
force-pushed
the
new-docs
branch
from
c4489e5 to
f375a69
Compare
| 2. If you are using `vets-website` as your consuming app and it is already running, it should notice the changes and rebuild. If not, restart the app locally. | ||
| 3. After rebuilding completes, your changes will now be visible locally at `localhost:3001`. | ||
|
|
||
| ## Tearing down the local testing setup |
There was a problem hiding this comment.
This is a great addition, good idea.
previewing-changes.md
Outdated
|
|
||
| In the consuming app: | ||
| 1. run `yalc remove @department-of-veterans-affairs/formation` to remove the link from the consuming app's `node_modules` dir to the local version of `formation`. | ||
| 2. **NOTE:** There seems to be an issue with Yalc not cleaning up after itself properly, so you'll have to also run `unlink node_modules/@department-of-veterans-affairs/formation` |
There was a problem hiding this comment.
Is it possible to provide a link to any bug reports here?
There was a problem hiding this comment.
Sadly I didn't see an open issue for this (which means I should file one myself!). I also tested yalc add instead of yalc link to see if the cleanup went more smoothly. Sadly it did not.
I'll file a bug a add a link to it here.
|
I just spent a chunk of time seeing it plain old |
This is a major rework of the instructions on making changes to the module and previewing them locally. I hope I made things cleared and more complete. I did remove what I thought were some unnecessary details in the old instructions. I also added info on tearing down the test set up and restoring things. The original instructions totally lacked those.
I'd encourage you to go through these instructions yourself and make sure that they are clear, accurate, and complete. If you do, I'd suggest that you simply change the main background color as a simple test to make sure you can preview the change in
vets-website.A few thoughts/questions:
design-systembut the published module isformation? Not a big deal, but it can potentially lead to a little confusion.test-publishNPM script to first runexport-components. It's hard to imagine a scenario where you'd want to publish locally without first building the module. Or maybe I should just make a new script that does both; it's silly to have to run twodesign-systemscripts each time you want to see your changes.