From 29829836390b0c95675c54bb586614f58735dc39 Mon Sep 17 00:00:00 2001 From: Melissa Luu Date: Wed, 5 Jul 2023 15:27:34 -0400 Subject: [PATCH] Update docs to reflect new main default branch --- .github/ISSUE_TEMPLATE/Bug_report.md | 8 ++++---- .github/ISSUE_TEMPLATE/Feature_request.md | 4 ++-- CHANGELOG.md | 2 +- CONTRIBUTING.md | 2 +- DEPLOYING.md | 6 +++--- README.md | 12 ++++++------ docs/CheckoutResource.html | 2 +- docs/Client.html | 2 +- docs/CollectionResource.html | 2 +- docs/Config.html | 2 +- docs/ImageHelpers.html | 2 +- docs/ImageResource.html | 2 +- docs/ProductHelpers.html | 2 +- docs/ProductResource.html | 2 +- docs/ShopResource.html | 2 +- docs/checkout-resource.js.html | 2 +- docs/client.js.html | 2 +- docs/collection-resource.js.html | 2 +- docs/config.js.html | 2 +- docs/image-helpers.js.html | 2 +- docs/image-resource.js.html | 2 +- docs/index.html | 16 ++++++++-------- docs/product-helpers.js.html | 2 +- docs/product-resource.js.html | 2 +- docs/shop-resource.js.html | 2 +- docs/tutorial-MIGRATION_GUIDE.html | 2 +- 26 files changed, 44 insertions(+), 44 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md index dd6f1babe..fb011ec80 100644 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -10,11 +10,11 @@ assignees: '' **Please complete the checklist before filing an issue:** - [ ] Is this a "how to" question? For questions on how to use the SDK, implement features or other related questions, [please use our forums](https://community.shopify.com/c/Shopify-APIs-SDKs/bd-p/shopify-apis-and-technology). -- [ ] Is this something you can **debug and fix**? Create a pull request and contribute! Bug fixes and documentation fixes are welcome. You can read our [contribution](https://github.com/Shopify/js-buy-sdk/blob/master/CONTRIBUTING.md) guidelines for more details. +- [ ] Is this something you can **debug and fix**? Create a pull request and contribute! Bug fixes and documentation fixes are welcome. You can read our [contribution](https://github.com/Shopify/js-buy-sdk/blob/main/CONTRIBUTING.md) guidelines for more details. None of the above? Create an issue. Be sure to include all the necessary information for us to understand and reproduce the problem: -### Bug details +### Bug details **Describe the bug** A clear and concise description of what the bug is. @@ -38,7 +38,7 @@ A clear and concise description of what you expected to happen. Add any other context about the problem here. **Bug Report Checklist** -- [ ] I have read and agree to the [CODE_OF_CONDUCT.md](https://github.com/Shopify/js-buy-sdk/blob/master/CODE_OF_CONDUCT.md) -- [ ] I have read the [CONTRIBUTING.md](https://github.com/Shopify/js-buy-sdk/blob/master/CONTRIBUTING.md) guidelines. +- [ ] I have read and agree to the [CODE_OF_CONDUCT.md](https://github.com/Shopify/js-buy-sdk/blob/main/CODE_OF_CONDUCT.md) +- [ ] I have read the [CONTRIBUTING.md](https://github.com/Shopify/js-buy-sdk/blob/main/CONTRIBUTING.md) guidelines. - [ ] I have provided a detailed description of the bug, including code samples, and/or network data. - [ ] I have provided information about my development environment, including SDK version. diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md index 06eee8994..891615205 100644 --- a/.github/ISSUE_TEMPLATE/Feature_request.md +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -10,11 +10,11 @@ assignees: '' **Please complete the checklist before filing an issue:** - [ ] Is this a "how to" question? For questions on how to use the SDK, implement features or other related questions, [please use our forums](https://community.shopify.com/c/Shopify-APIs-SDKs/bd-p/shopify-apis-and-technology). -- [ ] Is this something you can **debug and fix**? Create a pull request and contribute! Bug fixes and documentation fixes are welcome. You can read our [contribution](https://github.com/Shopify/js-buy-sdk/blob/master/CONTRIBUTING.md) guidelines for more details. +- [ ] Is this something you can **debug and fix**? Create a pull request and contribute! Bug fixes and documentation fixes are welcome. You can read our [contribution](https://github.com/Shopify/js-buy-sdk/blob/main/CONTRIBUTING.md) guidelines for more details. None of the above? Create an issue. Be sure to include all the necessary information for us to understand and reproduce the problem: -### Feature details +### Feature details **Is your feature request related to a problem? Please describe.** A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] diff --git a/CHANGELOG.md b/CHANGELOG.md index 25f3c1825..3a3f6dd42 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -69,7 +69,7 @@ * Updates some description strings in the Storefront API schema version `2019-10`. * Adds an optional param to `collection.fetchWithProducts` for specifying the number of products to return. * Adds `priceV2` to the `shippingLine` object in the checkout fragment -* Update the [contributing guide](https://github.com/Shopify/js-buy-sdk/blob/master/CONTRIBUTING.md) to recommend using `yarn` instead of `npm`. +* Update the [contributing guide](https://github.com/Shopify/js-buy-sdk/blob/main/CONTRIBUTING.md) to recommend using `yarn` instead of `npm`. ### v2.8.0 (October 3, 2019) * Bumps the SDK to use Storefront API version `2019-10`. For more information, see the [Release Notes](https://help.shopify.com/en/api/versioning/release-notes/2019-10#storefront-api-changes). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8fdc8ce35..ea2b51114 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,7 @@ # How to contribute We ❤️ pull requests. If you'd like to fix a bug, contribute a feature or just correct a typo, please feel free to do so, as long as you follow -our [Code of Conduct](https://github.com/Shopify/js-buy-sdk/blob/master/CODE_OF_CONDUCT.md). +our [Code of Conduct](https://github.com/Shopify/js-buy-sdk/blob/main/CODE_OF_CONDUCT.md). If you're thinking of adding a big new feature, consider opening an issue first to discuss it to ensure it aligns to the direction of the diff --git a/DEPLOYING.md b/DEPLOYING.md index 028def08e..7d190f796 100644 --- a/DEPLOYING.md +++ b/DEPLOYING.md @@ -1,11 +1,11 @@ # Deploying JS Buy SDK -1. Merge your branch into master +1. Merge your branch into main 2. Run `npm version [patch|minor|major]` which will do the following: * write new version to package.json * create a commit with a commit message matching the version number * create a new tag matching the version number -3. Push the new commit and tags to master with `git push && git push --tags` +3. Push the new commit and tags to main with `git push && git push --tags` 4. Deploy built scripts to s3 via [shipit](https://shipit.shopify.io/shopify/js-buy-sdk/production) # Updating Documentation @@ -21,4 +21,4 @@ updated together, the diff will be huge and it will be difficult to review. 1. Generate documentation using `npm run doc:build` or `yarn doc:build` 2. Update the [Changelog](https://github.com/Shopify/js-buy-sdk/CHANGELOG.md) with details about the release. -3. Merge your branch into master +3. Merge your branch into main diff --git a/README.md b/README.md index 734c16d6e..8b43a3032 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ![Build](https://github.com/shopify/js-buy-sdk/actions/workflows/ci.yml/badge.svg) **Note**: For help with migrating from v0 of JS Buy SDK to v1 check out the -[Migration Guide](https://github.com/Shopify/js-buy-sdk/blob/master/tutorials/MIGRATION_GUIDE.md). +[Migration Guide](https://github.com/Shopify/js-buy-sdk/blob/main/tutorials/MIGRATION_GUIDE.md). The JS Buy SDK is a lightweight library that allows you to build ecommerce into any website. It's based on Shopify's [Storefront API](https://help.shopify.com/api/storefront-api/getting-started) @@ -12,7 +12,7 @@ and provides the ability to retrieve products and collections from your shop, ad ## Changelog -View our [Changelog](https://github.com/Shopify/js-buy-sdk/blob/master/CHANGELOG.md) for details about our releases. +View our [Changelog](https://github.com/Shopify/js-buy-sdk/blob/main/CHANGELOG.md) for details about our releases. ## Table Of Contents @@ -53,7 +53,7 @@ $ npm install shopify-buy **CDN:** -There is a minified UMD build of the latest release available via CDN (see the [Changelog](https://github.com/Shopify/js-buy-sdk/blob/master/CHANGELOG.md) for details about the latest release): +There is a minified UMD build of the latest release available via CDN (see the [Changelog](https://github.com/Shopify/js-buy-sdk/blob/main/CHANGELOG.md) for details about the latest release): ```html @@ -330,14 +330,14 @@ There are JS Buy SDK specific example apps in Node, Ember, and React. You can us ## Contributing For help on setting up the repo locally, building, testing, and contributing -please see [CONTRIBUTING.md](https://github.com/Shopify/js-buy-sdk/blob/master/CONTRIBUTING.md). +please see [CONTRIBUTING.md](https://github.com/Shopify/js-buy-sdk/blob/main/CONTRIBUTING.md). ## Code of Conduct All developers who wish to contribute through code or issues, take a look at the -[CODE_OF_CONDUCT.md](https://github.com/Shopify/js-buy-sdk/blob/master/CODE_OF_CONDUCT.md). +[CODE_OF_CONDUCT.md](https://github.com/Shopify/js-buy-sdk/blob/main/CODE_OF_CONDUCT.md). ## License -MIT, see [LICENSE.md](https://github.com/Shopify/js-buy-sdk/blob/master/LICENSE.txt) for details. +MIT, see [LICENSE.md](https://github.com/Shopify/js-buy-sdk/blob/main/LICENSE.txt) for details. diff --git a/docs/CheckoutResource.html b/docs/CheckoutResource.html index 90f12adf8..6e60f744c 100644 --- a/docs/CheckoutResource.html +++ b/docs/CheckoutResource.html @@ -3032,7 +3032,7 @@

Home

Namespaces