[Documentation] Add versioning strategy topic (#1023)

* Add versioning strategy topic

* Replace all instances of release/2.0 to develop

* Replace 'develop' with 'master'when using links to github

pwa-devdocs/src/_config.yml

@@ -10,7 +10,7 @@ logo: PWA Docs
 github_link: true
 feedback_link: true
 github_repo: "https://github.com/magento-research/pwa-studio/"
-github_files: "https://github.com/magento-research/pwa-studio/tree/release/2.0/pwa-devdocs/src/"
+github_files: "https://github.com/magento-research/pwa-studio/tree/master/pwa-devdocs/src/"
 
 
 defaults:

pwa-devdocs/src/_data/technologies.yml

@@ -33,3 +33,6 @@ entries:
 
   - label: Contributing to PWA Studio
     url: /technologies/contribute/
+
+  - label: Versioning strategy
+    url: /technologies/versioning/

pwa-devdocs/src/index.html

@@ -93,7 +93,7 @@ <h2>PWA Studio in GitHub</h2>
       <div class="column">
         <article class="repository tile">
           <h3>
-            <a href="https://github.com/magento-research/pwa-studio/tree/release/2.0/packages/venia-concept">Venia Storefront source</a>
+            <a href="https://github.com/magento-research/pwa-studio/tree/master/packages/venia-concept">Venia Storefront source</a>
           </h3>
           <p>
             Project source code for a conceptual and customizable PWA storefront for Magento 2.
@@ -105,7 +105,7 @@ <h3>
       <div class="column">
         <article class="repository tile">
           <h3>
-            <a href="https://github.com/magento-research/pwa-studio/tree/release/2.0/packages/peregrine">Peregrine source</a>
+            <a href="https://github.com/magento-research/pwa-studio/tree/master/packages/peregrine">Peregrine source</a>
           </h3>
           <p>
             Project source code for the collection of UI components for the Magento PWA projects.
@@ -116,7 +116,7 @@ <h3>
       <div class="column">
         <article class="repository tile">
           <h3>
-            <a href="https://github.com/magento-research/pwa-studio/tree/release/2.0/packages/pwa-buildpack">Buildpack source</a>
+            <a href="https://github.com/magento-research/pwa-studio/tree/master/packages/pwa-buildpack">Buildpack source</a>
           </h3>
           <p>
             Project source code for the build and layout optimization tooling for Magento PWA projects.

pwa-devdocs/src/peregrine/routing/index.md

@@ -137,13 +137,13 @@ class App extends Component {
 ...
 ```
 
-[`Router.js`]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/peregrine/src/Router/Router.js
-[`MagentoRouteHandler.js`]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/peregrine/src/Router/MagentoRouteHandler.js
-[`resolveUnknownRoute.js`]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/peregrine/src/Router/resolveUnknownRoute.js
-[`webpackInterop.js`]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/peregrine/src/Router/webpackInterop.js
-[`Page.js`]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/peregrine/src/Page/Page.js
+[`Router.js`]: https://github.com/magento-research/pwa-studio/blob/master/packages/peregrine/src/Router/Router.js
+[`MagentoRouteHandler.js`]: https://github.com/magento-research/pwa-studio/blob/master/packages/peregrine/src/Router/MagentoRouteHandler.js
+[`resolveUnknownRoute.js`]: https://github.com/magento-research/pwa-studio/blob/master/packages/peregrine/src/Router/resolveUnknownRoute.js
+[`webpackInterop.js`]: https://github.com/magento-research/pwa-studio/blob/master/packages/peregrine/src/Router/webpackInterop.js
+[`Page.js`]: https://github.com/magento-research/pwa-studio/blob/master/packages/peregrine/src/Page/Page.js
 [`react-router`]: https://github.com/ReactTraining/react-router
 [React Context]: https://reactjs.org/docs/context.html
-[ErrorView]:t://github.com/magento-research/pwa-studio/blob/release/2.0/packages/venia-concept/src/components/ErrorView/errorView.js 
-[App]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/venia-concept/src/components/App/app.js
+[ErrorView]:t://github.com/magento-research/pwa-studio/blob/master/packages/venia-concept/src/components/ErrorView/errorView.js 
+[App]: https://github.com/magento-research/pwa-studio/blob/master/packages/venia-concept/src/components/App/app.js
 [Loading and error message components]: #loading-and-error-message-components

pwa-devdocs/src/technologies/contribute/index.md

@@ -93,8 +93,8 @@ Provide as much detail as you can in each section to help us triage and process
 **Note:**
 _Please avoid creating GitHub issues asking for help on bugs in your project that are outside the scope of this project._
 
-[code of conduct]: https://github.com/magento-research/pwa-studio/blob/release/2.0/.github/CODE_OF_CONDUCT.md
-[support]: https://github.com/magento-research/pwa-studio/blob/release/2.0/.github/SUPPORT.md
+[code of conduct]: https://github.com/magento-research/pwa-studio/blob/master/.github/CODE_OF_CONDUCT.md
+[support]: https://github.com/magento-research/pwa-studio/blob/master/.github/SUPPORT.md
 [official repository]: https://github.com/magento-research/pwa-studio
 [meaningful commit messages]: https://chris.beams.io/posts/git-commit/
 [github issue]: https://github.com/magento-research/pwa-studio/issues/new

pwa-devdocs/src/technologies/upward/index.md

@@ -85,9 +85,9 @@ This supports the need for content that a PWA can [cache and reuse when offline]
 [HTTPS]: https://developers.google.com/web/fundamentals/security/encrypt-in-transit/why-https
 [edge servers]: https://en.wikipedia.org/wiki/Content_delivery_network
 [idempotent]: https://developer.mozilla.org/en-US/docs/Glossary/Idempotent
-[RATIONALE.md]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/upward-spec/RATIONALE.md
-[`venia-upward.yml`]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/venia-concept/venia-upward.yml
-[upward-js]: https://github.com/magento-research/pwa-studio/tree/release/2.0/packages/upward-js
+[RATIONALE.md]: https://github.com/magento-research/pwa-studio/blob/master/packages/upward-spec/RATIONALE.md
+[`venia-upward.yml`]: https://github.com/magento-research/pwa-studio/blob/master/packages/venia-concept/venia-upward.yml
+[upward-js]: https://github.com/magento-research/pwa-studio/tree/master/packages/upward-js
 [cache and reuse when offline]: https://developers.google.com/web/fundamentals/instant-and-offline/offline-cookbook/
 
 [Reference Implementation]: {{ site.baseurl }}{% link technologies/upward/reference-implementation/index.md %}

pwa-devdocs/src/technologies/upward/reference-implementation/index.md

@@ -81,7 +81,7 @@ app.use(middleware('./my-upward-server.yml'));
 
 You can also pass an `IOAdapter` as a second argument to the middleware.
 
-[upward-js]: https://github.com/magento-research/pwa-studio/tree/release/2.0/packages/upward-js
+[upward-js]: https://github.com/magento-research/pwa-studio/tree/master/packages/upward-js
 
 [UPWARD]: {{site.baseurl}}{% link technologies/upward/index.md %}
 [Setting up Venia]: {{site.baseurl}}{% link venia-pwa-concept/setup/index.md %}

pwa-devdocs/src/technologies/versioning/index.md

@@ -0,0 +1,36 @@
+---
+title: Versioning strategy
+---
+
+## Rules for incrementing the version
+
+PWA Studio follows [Semantic Versioning][] rules when incrementing the version for each release.
+
+According to the Semantic Versioning specifications, given the `MAJOR.MINOR.PATCH` version number format:
+
+* **MAJOR** version increases happen when there are changes to the [public API][].
+* **MINOR** version increases happen when functionality is added while preserving backwards compatibility.
+* **PATCH** version increases happen for backwards-compatible bug fixes.
+
+See [Semantic Versioning][] documentation for specific details about the type of changes allowed within each version.
+
+## Public API
+
+PWA Studio considers the following to be part of its public API:
+
+### Published Venia and Peregrine components
+
+Venia and Peregrine make their components available through their `index.js` files.
+Any component exported through this file is considered public API.
+
+Sub-components can be found inside component directories.
+These components are not part of the public API unless they are exported in the component's `index.js` file.
+
+### Component props
+
+React components use props as input data to define how they look and behave.
+
+Since props affect how a component renders or acts, the props used by published PWA Studio components are considered public API.
+
+[Semantic Versioning]: https://semver.org/
+[public API]: #public-api

pwa-devdocs/src/venia-pwa-concept/features/braintree/index.md

@@ -32,7 +32,7 @@ Use the following mock data to pass validation and ensure a successful checkout.
 {:style="table-layout:auto"}
 
 [braintree]: https://www.braintreepayments.com/
-[`braintreedropin.js`]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/venia-concept/src/components/Checkout/braintreeDropin.js
+[`braintreedropin.js`]: https://github.com/magento-research/pwa-studio/blob/master/packages/venia-concept/src/components/Checkout/braintreeDropin.js
 [this list]: https://developers.braintreepayments.com/guides/credit-cards/testing-go-live/node#valid-card-numbers
 [Braintree Drop-in]: https://github.com/braintree/braintree-web-drop-in
 [Braintree Drop-in docs]: https://braintree.github.io/braintree-web-drop-in/docs/current/index.html

pwa-devdocs/src/venia-pwa-concept/features/checkout/index.md

@@ -179,15 +179,15 @@ This screen shows the recently stored order ID number and buttons to **Continue
 [`guest-carts/<cartid>`]: https://devdocs.magento.com/redoc/2.3/guest-rest-api.html#tag/guest-cartscartId
 [`guest-carts/<cartid>/totals`]: https://devdocs.magento.com/redoc/2.3/guest-rest-api.html#tag/guest-cartscartIdtotals
 [`guest-carts/<cartid>/estimate-shipping-methods`]: https://devdocs.magento.com/redoc/2.3/guest-rest-api.html#tag/guest-cartscartIdestimate-shipping-methods
-[src/actions/cart/asyncactions.js]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/venia-concept/src/actions/cart/asyncActions.js
-[src/actions/app/asyncactions.js]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/venia-concept/src/actions/app/asyncActions.js
-[src/actions/checkout/asyncactions.js]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/venia-concept/src/actions/checkout/asyncActions.js
-[src/components/checkout/flow.js]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/venia-concept/src/components/Checkout/flow.js
-[src/actions/directory/asyncactions.js]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/venia-concept/src/actions/directory/asyncActions.js
+[src/actions/cart/asyncactions.js]: https://github.com/magento-research/pwa-studio/blob/master/packages/venia-concept/src/actions/cart/asyncActions.js
+[src/actions/app/asyncactions.js]: https://github.com/magento-research/pwa-studio/blob/master/packages/venia-concept/src/actions/app/asyncActions.js
+[src/actions/checkout/asyncactions.js]: https://github.com/magento-research/pwa-studio/blob/master/packages/venia-concept/src/actions/checkout/asyncActions.js
+[src/components/checkout/flow.js]: https://github.com/magento-research/pwa-studio/blob/master/packages/venia-concept/src/components/Checkout/flow.js
+[src/actions/directory/asyncactions.js]: https://github.com/magento-research/pwa-studio/blob/master/packages/venia-concept/src/actions/directory/asyncActions.js
 [`guest-carts/<cartid>/estimate-shipping-methods`]: https://devdocs.magento.com/redoc/2.3/guest-rest-api.html#tag/guest-cartscartIdestimate-shipping-methods
 [`directory/countries`]: https://devdocs.magento.com/redoc/2.3/guest-rest-api.html#tag/directorycountries
-[src/components/checkout/form.js]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/venia-concept/src/components/Checkout/form.js
+[src/components/checkout/form.js]: https://github.com/magento-research/pwa-studio/blob/master/packages/venia-concept/src/components/Checkout/form.js
 [`guest-carts/<cartid>/shipping-information`]: https://devdocs.magento.com/redoc/2.3/guest-rest-api.html#tag/guest-cartscartIdshipping-information
-[src/reducers/checkout.js]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/venia-concept/src/reducers/checkout.js
+[src/reducers/checkout.js]: https://github.com/magento-research/pwa-studio/blob/master/packages/venia-concept/src/reducers/checkout.js
 [`guest-carts/<cartid>/payment-information`]: https://devdocs.magento.com/redoc/2.3/guest-rest-api.html#tag/guest-cartscartIdpayment-information
-[src/components/checkout/receipt/receipt.js]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/venia-concept/src/components/Checkout/Receipt/receipt.js
+[src/components/checkout/receipt/receipt.js]: https://github.com/magento-research/pwa-studio/blob/master/packages/venia-concept/src/components/Checkout/Receipt/receipt.js

pwa-devdocs/src/venia-pwa-concept/features/modular-components/index.md

@@ -180,20 +180,20 @@ See the [venia-consumer-example][] project to see how a non-Venia application ca
 [venia-consumer-example]: https://github.com/magento-research/venia-consumer-example
 [es modules]: https://hacks.mozilla.org/2018/03/es-modules-a-cartoon-deep-dive/
 [webpack optimization]: https://webpack.js.org/guides/tree-shaking/
-[loadingindicator]: https://github.com/magento-research/pwa-studio/tree/release/2.0/packages/venia-concept/src/components/LoadingIndicator
-[richtext]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/venia-concept/src/components/RichText
-[venia adapter]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/venia-concept/src/drivers/adapter.js
-[productfulldetail]: https://github.com/magento-research/pwa-studio/tree/release/2.0/packages/venia-concept/src/components/ProductFullDetail
-[categorylist]: https://github.com/magento-research/pwa-studio/tree/release/2.0/packages/venia-concept/src/components/CategoryList
-[`src/drivers`]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/venia-concept/src/drivers/index.js
+[loadingindicator]: https://github.com/magento-research/pwa-studio/tree/master/packages/venia-concept/src/components/LoadingIndicator
+[richtext]: https://github.com/magento-research/pwa-studio/blob/master/packages/venia-concept/src/components/RichText
+[venia adapter]: https://github.com/magento-research/pwa-studio/blob/master/packages/venia-concept/src/drivers/adapter.js
+[productfulldetail]: https://github.com/magento-research/pwa-studio/tree/master/packages/venia-concept/src/components/ProductFullDetail
+[categorylist]: https://github.com/magento-research/pwa-studio/tree/master/packages/venia-concept/src/components/CategoryList
+[`src/drivers`]: https://github.com/magento-research/pwa-studio/blob/master/packages/venia-concept/src/drivers/index.js
 [apollo]: https://www.apollographql.com/docs/react/
 [react redux]: https://react-redux.js.org/
 [redux store]: https://redux.js.org/api/store
 [redux `provider`]: https://react-redux.js.org/api/provider
 [apollo client]: https://www.apollographql.com/docs/react/essentials/get-started.html#creating-client
 [webpack]: https://webpack.js.org/
 [rollup]: https://rollupjs.org/guide/en
-[`makeUrl.js`]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/venia-concept/src/util/makeUrl.js
+[`makeUrl.js`]: https://github.com/magento-research/pwa-studio/blob/master/packages/venia-concept/src/util/makeUrl.js
 [`adapter.js`]: https://github.com/magento-research/pwa-studio/blob/a40c4a7b9c5e7161e4e1534eb90e511d6559e36b/packages/venia-concept/src/drivers/adapter.js
 
 [Peregrine]: {{site.baseurl}}{%link peregrine/index.md %}

pwa-devdocs/src/venia-pwa-concept/project-structure/index.md

@@ -155,7 +155,7 @@ The `src/sw.js` file contains the service worker configuration.
 
 
 [Magento theme structure]: https://devdocs.magento.com/guides/v2.3/frontend-dev-guide/themes/theme-structure.html
-[UPWARD]: https://github.com/magento-research/pwa-studio/tree/release/2.0/packages/upward-spec
+[UPWARD]: https://github.com/magento-research/pwa-studio/tree/master/packages/upward-spec
 [Webpack]: https://webpack.js.org/
 [Install Venia sample data]: {{ site.baseurl }}{% link venia-pwa-concept/install-sample-data/index.md %}
 [Venia setup]: {{ site.baseurl }}{% link venia-pwa-concept/setup/index.md %}
@@ -172,14 +172,14 @@ The `src/sw.js` file contains the service worker configuration.
 [Redux middleware pattern]: https://redux.js.org/advanced/middleware
 [UPWARD server specification]: {{site.baseurl}}{%link technologies/upward/index.md %}
 [mustache]: https://mustache.github.io/
-[`.env.dist`]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/venia-concept/.env.dist
-[`deployVeniaSampleData.sh`]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/venia-concept/deployVeniaSampleData.sh
-[`server.js`]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/venia-concept/server.js
-[`validate-environment.js`]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/venia-concept/validate-environment.js
-[`venia-concept`]: https://github.com/magento-research/pwa-studio/tree/release/2.0/packages/venia-concept
-[`validate-queries.js`]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/venia-concept/validate-queries.js 
-[`venia-upward.yml`]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/venia-concept/venia-upward.yml
-[`templates`]: https://github.com/magento-research/pwa-studio/tree/release/2.0/packages/venia-concept/templates
-[`static`]: https://github.com/magento-research/pwa-studio/tree/release/2.0/packages/venia-concept/static
-[`src`]: https://github.com/magento-research/pwa-studio/tree/release/2.0/packages/venia-concept/src
-[`webpack.config.js`]: https://github.com/magento-research/pwa-studio/blob/release/2.0/packages/venia-concept/webpack.config.js
+[`.env.dist`]: https://github.com/magento-research/pwa-studio/blob/master/packages/venia-concept/.env.dist
+[`deployVeniaSampleData.sh`]: https://github.com/magento-research/pwa-studio/blob/master/packages/venia-concept/deployVeniaSampleData.sh
+[`server.js`]: https://github.com/magento-research/pwa-studio/blob/master/packages/venia-concept/server.js
+[`validate-environment.js`]: https://github.com/magento-research/pwa-studio/blob/master/packages/venia-concept/validate-environment.js
+[`venia-concept`]: https://github.com/magento-research/pwa-studio/tree/master/packages/venia-concept
+[`validate-queries.js`]: https://github.com/magento-research/pwa-studio/blob/master/packages/venia-concept/validate-queries.js 
+[`venia-upward.yml`]: https://github.com/magento-research/pwa-studio/blob/master/packages/venia-concept/venia-upward.yml
+[`templates`]: https://github.com/magento-research/pwa-studio/tree/master/packages/venia-concept/templates
+[`static`]: https://github.com/magento-research/pwa-studio/tree/master/packages/venia-concept/static
+[`src`]: https://github.com/magento-research/pwa-studio/tree/master/packages/venia-concept/src
+[`webpack.config.js`]: https://github.com/magento-research/pwa-studio/blob/master/packages/venia-concept/webpack.config.js

pwa-devdocs/src/venia-pwa-concept/setup/index.md

@@ -132,7 +132,7 @@ for PWA development on the frontend, use this new address.
 
 Congratulations! You have set up your development environment for the Venia storefront project.
 
-[Venia PWA concept storefront]: https://github.com/magento-research/pwa-studio/tree/release/2.0/packages/venia-concept
+[Venia PWA concept storefront]: https://github.com/magento-research/pwa-studio/tree/master/packages/venia-concept
 [Vagrant Box for Magento 2 developers]: https://github.com/paliarush/magento2-vagrant-for-developers
 [Troubleshooting]: {{ site.baseurl }}{% link pwa-buildpack/troubleshooting/index.md %}
 [PWA Studio]: https://github.com/magento-research/pwa-studio