From 7a402dc41f767696e80dd29ff5501d024ea5cfeb Mon Sep 17 00:00:00 2001 From: geethag-tw Date: Thu, 11 Jul 2024 18:27:57 +0530 Subject: [PATCH] docs(developerGuidelines): [BLA-803] Update the docker command to run and update snapshots --- packages/core-components/src/components/modal/modal.docs.mdx | 2 +- packages/core-components/src/docs/guidelines/DEV-GUIDELINES.md | 2 +- test.Docker.README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/core-components/src/components/modal/modal.docs.mdx b/packages/core-components/src/components/modal/modal.docs.mdx index db82b2a2..b8f963c5 100644 --- a/packages/core-components/src/components/modal/modal.docs.mdx +++ b/packages/core-components/src/components/modal/modal.docs.mdx @@ -38,7 +38,7 @@ to 800px. The modal height is not limited. We recommend using the `large` varian While the headline property is required and will always be shown in the modal, other parts of the modal such as the body and footer content are optional. -Header has one slot - 'header-icon' that controls the icon to be displayed near the modal title. +Header has one slot - `header-icon` that controls the icon to be displayed near the modal title. ### Body Content diff --git a/packages/core-components/src/docs/guidelines/DEV-GUIDELINES.md b/packages/core-components/src/docs/guidelines/DEV-GUIDELINES.md index e031ed5a..5dd265bc 100644 --- a/packages/core-components/src/docs/guidelines/DEV-GUIDELINES.md +++ b/packages/core-components/src/docs/guidelines/DEV-GUIDELINES.md @@ -193,7 +193,7 @@ Once you have one of this two runtime envs, you can follow these steps: 1. Run `docker-compose up` or `docker-compose up --build` if you have created the services before. This creates a storybook service and a service that runs the tests against storybook. If any test failed, you will find a new folder inside `__snapshots__` called `__diff_output__`. -2. If the differences were expected (because you made visual changes to an existing component), run `docker-compose run run-tests npx test-storybook --verbose --url http://storybook:6006 -u` +2. If the differences were expected (because you made visual changes to an existing component), run `docker-compose run run-tests npx test-storybook --verbose --url http://storybook.local:6006 -u` #### Making changes to the docker image diff --git a/test.Docker.README.md b/test.Docker.README.md index 52120916..38c52692 100644 --- a/test.Docker.README.md +++ b/test.Docker.README.md @@ -14,6 +14,6 @@ This rebuilds the storybook and test-runner services to include recent changes a If there is a new component, simply rebuilding starting the services is enough as the normal entrypoint automatically adds new screenshots. However, if you made intended visual changes to an existing component, you will need to run: -`docker-compose run run-tests npx test-storybook --verbose --url http://storybook:6006 -u` +`docker-compose run run-tests npx test-storybook --verbose --url http://storybook.local:6006 -u` to override the default command and update the snapshots. \ No newline at end of file