adjust readme for v2 release #612
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kevinxh
reviewed
May 16, 2022
kevinxh
reviewed
May 16, 2022
kevinxh
reviewed
May 16, 2022
kevinxh
reviewed
May 16, 2022
kevinxh
approved these changes
May 16, 2022
|
btw I wouldn't mind more emojis 😆 |
12 tasks
rsexton404
reviewed
May 16, 2022
rsexton404
reviewed
May 16, 2022
rsexton404
reviewed
May 16, 2022
adamraya
reviewed
May 16, 2022
rsexton404
reviewed
May 16, 2022
rsexton404
reviewed
May 16, 2022
packages/pwa-kit-dev/README.md
Outdated
| @@ -1 +1,23 @@ | |||
| # PWA Kit Developer Tools | |||
|
|
|||
| A command line interface tool to develop, build and deploy PWA Kit projects. | |||
There was a problem hiding this comment.
Suggested change
| A command line interface tool to develop, build and deploy PWA Kit projects. | |
| A command line interface tool to develop, build, and deploy PWA Kit projects. |
rsexton404
reviewed
May 16, 2022
| @@ -43,15 +43,15 @@ The configuration features include: | |||
|
|
|||
| ### Dedicated Configuration Files | |||
|
|
|||
| At project generation a single `default` configuration is created. For most cases a single configuration file will get the job done. But there are times where you want to have a different configuration for a different environment. These environments for example could be, a developers local machine, a remote `production` environment, or a remote `staging` environment. In all these cases you want to use a different configuration for each. | |||
| At project generation a single `default` configuration is created. For most cases a single configuration file will get the job done. But there are times when you want to have a different configuration for a different environment. These environments for example could be, a developers local machine, a remote `production` environment, or a remote `staging` environment. In all these cases you want to use a different configuration for each. | |||
|
|
|||
| When multiple configurations are present, which configuration file to used is resolved in the following way: | |||
There was a problem hiding this comment.
Suggested change
| When multiple configurations are present, which configuration file to used is resolved in the following way: | |
| When multiple configurations are present, here's how the correct configuration file is chosen: |
rsexton404
reviewed
May 16, 2022
|
|
||
| When multiple configurations are present, which configuration file to used is resolved in the following way: | ||
|
|
||
| 1. Check to see if there is a config file named after your remote Managed Runtime environment and use this if one is present. | ||
| 2. If we are running on a developer machine, look for a `local` configuration and use this if one is present. | ||
| 3. Load the `default` config file `config/default.js`. | ||
|
|
||
| This allows you do these but not limited to things: | ||
| This allows you to do these but are not limited to things: |
There was a problem hiding this comment.
Suggested change
| This allows you to do these but are not limited to things: | |
| This configuration system enables the following use cases: |
rsexton404
reviewed
May 16, 2022
| @@ -71,7 +71,7 @@ module.exports = { | |||
| } | |||
| } | |||
| ``` | |||
| You can choose how the current locale appears (or doesn’t appear) in the URL by setting `url.locale` to one of the following values: | |||
| You can choose how the current locale appears (or does not appear) in the URL by setting `url.locale` to one of the following values: | |||
There was a problem hiding this comment.
Suggested change
| You can choose how the current locale appears (or does not appear) in the URL by setting `url.locale` to one of the following values: | |
| You can choose how the current locale appears (or doesn't appear) in the URL by setting `url.locale` to one of the following values: |
^Salesforce style: use contractions (like "doesn't") whenever possible.
rsexton404
reviewed
May 16, 2022
|
|
||
| When multiple configurations are present, which configuration file to used is resolved in the following way: | ||
|
|
||
| 1. Check to see if there is a config file named after your remote Managed Runtime environment and use this if one is present. | ||
| 2. If we are running on a developer machine, look for a `local` configuration and use this if one is present. | ||
| 3. Load the `default` config file `config/default.js`. | ||
|
|
||
| This allows you do these but not limited to things: | ||
| This allows you to do these but are not limited to things: | ||
|
|
||
| - Each developer can have their own configuration, connection to their own Commerce API sandboxes. | ||
| - Deploy a single codebase application to multiple environments with their own specific configurations (Multiple B2C Site with Different Domains). |
There was a problem hiding this comment.
Suggested change
| - Deploy a single codebase application to multiple environments with their own specific configurations (Multiple B2C Site with Different Domains). | |
| - Deploy a single PWA Kit codebase to multiple environments, each with their own configuration. |
There was a problem hiding this comment.
Previously we have This configuration system allows you to:, it makes sense to start this sentence with deploy...
There was a problem hiding this comment.
Sure, we can do that but we need to make both list items parallel (consistent sentence structure).
There was a problem hiding this comment.
Anw, let's not too caught up with this section here. We can always fix it up later on. I will stop pushing any change and wait for the CI to merge this PR . Thank you for all the feedback @rsexton404!
There was a problem hiding this comment.
Scratch that. I'm just going to use the text we already wrote for the docs instead.
rsexton404
reviewed
May 16, 2022
rsexton404
reviewed
May 16, 2022
rsexton404
reviewed
May 16, 2022
rsexton404
reviewed
May 16, 2022
|
|
||
| 1. Check to see if there is a config file named after your remote Managed Runtime environment and use this if one is present. | ||
| 2. If we are running on a developer machine, look for a `local` configuration and use this if one is present. | ||
| 3. Load the `default` config file `config/default.js`. | ||
|
|
||
| This allows you do these but not limited to things: | ||
| This configuration system allows you to do the following: |
There was a problem hiding this comment.
Suggested change
| This configuration system allows you to do the following: | |
| This configuration system allows you to: |
adamraya
added a commit
that referenced
this pull request
May 17, 2022
* Release V2.0.0-alpha.0 (#593) * Bump V2 to `2.0.0-dev.8` (#575) * Bump version * Fix up readme for new package * Fixed loading correct amount of skeletons (#576) Port PR 525 into V2 * Make sure that generated project has pwa-kit-* packages pinned (#577) * Add comment explaining dev server import. (#578) * Add comment explaining dev server import. * lint:fix * [V2][Generator] Add `typescript-minimal` and `typescript-minimal-test-project` presets (#574) * Add `typescript-minimal` and `typescript-minimal-test-project` presets * lint * copy * Testing CI parallelism * Testing CI parameters * PR Feedback * ops forgot to update two references * Move pwa-kit-runtime to as a dependency instead of devDependency (#572) * move pwa-kit-runtime to as a dependency instead of devDependency in pwa-kit-dev * Wjh/translations docs (#570) * Update translation readme Co-authored-by: Alex Vuong <alex.vuong@salesforce.com> Co-authored-by: Vincent Marta <vmarta@salesforce.com> * [V2] Implement dev server serveStaticFile (#580) * implement dev serveStaticFile * serve favicon in typescript template * add test * move mock closer to test case * [V2] Remove dadJoke in `template-typescript-minimal` (#585) * Replaced dadjoke with simple exp to demo getProps * Added a comment to explain mock function for getProps * Reduce getProps timeout to 50ms * remove unused manifest path (#582) * Silent output when cleaning config folder (#588) * [V2]Drop node 12 support for (#589) * drop node 12 in v2 * [V2] workaround shims issue windows (#584) * fix shims issue on Windows with a workaround * [V2] Clarify that service worker does not have to be hosted at the root (#590) * [V2] Add favicon for `template-retail-react-app` (#568) * Fix favicon path in ssr.js * Conditionally update favicon url to support dev & prod builds * Remove old serve favIcon flow and favIconPath option from config * Fix lint errors * Removed test for old serve favicon flow * remove references to faviconPath * Removed references to manifestPath * Bump v2 to v2.0.0-alpha.0 (#592) * Version 2.0.0-alpha.0 * Bump to 2.0.0-alpha.0 * Bump `pwa-kit-runtime` peerDependencies to 2.0.0-alpha.0 Co-authored-by: Adam Raya Navarro <arayanavarro@salesforce.com> Co-authored-by: Ben Chypak <bchypak@mobify.com> Co-authored-by: vcua-mobify <47404250+vcua-mobify@users.noreply.github.com> Co-authored-by: Vincent Marta <vmarta@salesforce.com> Co-authored-by: Will Harney <62956339+wjhsf@users.noreply.github.com> Co-authored-by: Alex Vuong <52219283+alexvuong@users.noreply.github.com> Co-authored-by: Kevin He <kevin.he@salesforce.com> Co-authored-by: Jainam Sheth <99490559+shethj@users.noreply.github.com> * Release 2.0.0-alpha.1 version (#610) * Bump V2 to `2.0.0-dev.8` (#575) * Bump version * Fix up readme for new package * Fixed loading correct amount of skeletons (#576) Port PR 525 into V2 * Make sure that generated project has pwa-kit-* packages pinned (#577) * Add comment explaining dev server import. (#578) * Add comment explaining dev server import. * lint:fix * [V2][Generator] Add `typescript-minimal` and `typescript-minimal-test-project` presets (#574) * Add `typescript-minimal` and `typescript-minimal-test-project` presets * lint * copy * Testing CI parallelism * Testing CI parameters * PR Feedback * ops forgot to update two references * Move pwa-kit-runtime to as a dependency instead of devDependency (#572) * move pwa-kit-runtime to as a dependency instead of devDependency in pwa-kit-dev * Wjh/translations docs (#570) * Update translation readme Co-authored-by: Alex Vuong <alex.vuong@salesforce.com> Co-authored-by: Vincent Marta <vmarta@salesforce.com> * [V2] Implement dev server serveStaticFile (#580) * implement dev serveStaticFile * serve favicon in typescript template * add test * move mock closer to test case * [V2] Remove dadJoke in `template-typescript-minimal` (#585) * Replaced dadjoke with simple exp to demo getProps * Added a comment to explain mock function for getProps * Reduce getProps timeout to 50ms * remove unused manifest path (#582) * Silent output when cleaning config folder (#588) * [V2]Drop node 12 support for (#589) * drop node 12 in v2 * [V2] workaround shims issue windows (#584) * fix shims issue on Windows with a workaround * [V2] Clarify that service worker does not have to be hosted at the root (#590) * [V2] Add favicon for `template-retail-react-app` (#568) * Fix favicon path in ssr.js * Conditionally update favicon url to support dev & prod builds * Remove old serve favIcon flow and favIconPath option from config * Fix lint errors * Removed test for old serve favicon flow * remove references to faviconPath * Removed references to manifestPath * Bump v2 to v2.0.0-alpha.0 (#592) * Version 2.0.0-alpha.0 * Bump to 2.0.0-alpha.0 * Bump `pwa-kit-runtime` peerDependencies to 2.0.0-alpha.0 Co-authored-by: Adam Raya Navarro <arayanavarro@salesforce.com> * Merge branch `release-2.0.x` into `v2` and bump version (#595) * Release V2.0.0-alpha.0 (#593) * Bump V2 to `2.0.0-dev.8` (#575) * Bump version * Fix up readme for new package * Fixed loading correct amount of skeletons (#576) Port PR 525 into V2 * Make sure that generated project has pwa-kit-* packages pinned (#577) * Add comment explaining dev server import. (#578) * Add comment explaining dev server import. * lint:fix * [V2][Generator] Add `typescript-minimal` and `typescript-minimal-test-project` presets (#574) * Add `typescript-minimal` and `typescript-minimal-test-project` presets * lint * copy * Testing CI parallelism * Testing CI parameters * PR Feedback * ops forgot to update two references * Move pwa-kit-runtime to as a dependency instead of devDependency (#572) * move pwa-kit-runtime to as a dependency instead of devDependency in pwa-kit-dev * Wjh/translations docs (#570) * Update translation readme Co-authored-by: Alex Vuong <alex.vuong@salesforce.com> Co-authored-by: Vincent Marta <vmarta@salesforce.com> * [V2] Implement dev server serveStaticFile (#580) * implement dev serveStaticFile * serve favicon in typescript template * add test * move mock closer to test case * [V2] Remove dadJoke in `template-typescript-minimal` (#585) * Replaced dadjoke with simple exp to demo getProps * Added a comment to explain mock function for getProps * Reduce getProps timeout to 50ms * remove unused manifest path (#582) * Silent output when cleaning config folder (#588) * [V2]Drop node 12 support for (#589) * drop node 12 in v2 * [V2] workaround shims issue windows (#584) * fix shims issue on Windows with a workaround * [V2] Clarify that service worker does not have to be hosted at the root (#590) * [V2] Add favicon for `template-retail-react-app` (#568) * Fix favicon path in ssr.js * Conditionally update favicon url to support dev & prod builds * Remove old serve favIcon flow and favIconPath option from config * Fix lint errors * Removed test for old serve favicon flow * remove references to faviconPath * Removed references to manifestPath * Bump v2 to v2.0.0-alpha.0 (#592) * Version 2.0.0-alpha.0 * Bump to 2.0.0-alpha.0 * Bump `pwa-kit-runtime` peerDependencies to 2.0.0-alpha.0 Co-authored-by: Adam Raya Navarro <arayanavarro@salesforce.com> Co-authored-by: Ben Chypak <bchypak@mobify.com> Co-authored-by: vcua-mobify <47404250+vcua-mobify@users.noreply.github.com> Co-authored-by: Vincent Marta <vmarta@salesforce.com> Co-authored-by: Will Harney <62956339+wjhsf@users.noreply.github.com> Co-authored-by: Alex Vuong <52219283+alexvuong@users.noreply.github.com> Co-authored-by: Kevin He <kevin.he@salesforce.com> Co-authored-by: Jainam Sheth <99490559+shethj@users.noreply.github.com> * Bump version to `2.0.0-alpha.1` * Manually bump version on `pwa-kit-runtime` peerDependency Co-authored-by: Ben Chypak <bchypak@mobify.com> Co-authored-by: vcua-mobify <47404250+vcua-mobify@users.noreply.github.com> Co-authored-by: Vincent Marta <vmarta@salesforce.com> Co-authored-by: Will Harney <62956339+wjhsf@users.noreply.github.com> Co-authored-by: Alex Vuong <52219283+alexvuong@users.noreply.github.com> Co-authored-by: Kevin He <kevin.he@salesforce.com> Co-authored-by: Jainam Sheth <99490559+shethj@users.noreply.github.com> * comment out the session bridge call (#597) * [v2] Automatically bind all factory methods (#598) * automatically bind all factory methods * bind remote server methods * bind object functions in getRuntime * add test for getRuntime * fix lint * Update CHANGELOG files (#608) * Update CHANGELOG files * Add more changes Co-authored-by: Ben Chypak <bchypak@mobify.com> Co-authored-by: vcua-mobify <47404250+vcua-mobify@users.noreply.github.com> Co-authored-by: Vincent Marta <vmarta@salesforce.com> Co-authored-by: Will Harney <62956339+wjhsf@users.noreply.github.com> Co-authored-by: Alex Vuong <52219283+alexvuong@users.noreply.github.com> Co-authored-by: Kevin He <kevin.he@salesforce.com> Co-authored-by: Jainam Sheth <99490559+shethj@users.noreply.github.com> * adjust readme for v2 release (#612) * adjust readme for v2 release * Release final V2 version (#613) * Version 2.0.0 * Bump peerDependency * Begin development on 2.1.0 * Bump peerDependecy Co-authored-by: Ben Chypak <bchypak@mobify.com> Co-authored-by: vcua-mobify <47404250+vcua-mobify@users.noreply.github.com> Co-authored-by: Vincent Marta <vmarta@salesforce.com> Co-authored-by: Will Harney <62956339+wjhsf@users.noreply.github.com> Co-authored-by: Alex Vuong <52219283+alexvuong@users.noreply.github.com> Co-authored-by: Kevin He <kevin.he@salesforce.com> Co-authored-by: Jainam Sheth <99490559+shethj@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Types of Changes
Changes
How to Test-Drive This PR
Checklists
General
Accessibility Compliance
You must check off all items in one of the follow two lists:
or...
Localization