Merge pull request #5260 from hotwax/typo/documentation

[Docs] Fixed some typos

Author: Fifciu

CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.13.0] - UNRELEASED
+
+### Fixed
+- Fixed some typo in docs (#5071)
+
 ## [1.12.2] - 2020.07.28
 
 ### Added

docs/guide/cookbook/checklist.md

@@ -435,7 +435,7 @@ This looks like by and large the same with *Vue Storefront API* with a few chang
 `app` service describes options for *Vue Storefront* frontend application.
 - `network_mode` allows you to modify values for `--network` option of docker client. `host` option allows your designated container to open to host network. For example, if you bind your container in host's `80` port, then the container will be accessible at host's `<IP address>:80` from the internet. In other words, the container is not isolated. [more info](https://docs.docker.com/network/host/)
 
-If you take a closer look inside `Dockerfile`s, you will notice they install all the dependencies of the project from `package.json` not to mention required OS features including `git`, `wget` and certificates. You don't have to worry what to do because we made it do for you.
+If you take a closer look inside `Dockerfile's`, you will notice they install all the dependencies of the project from `package.json` not to mention required OS features including `git`, `wget` and certificates. You don't have to worry what to do because we made it do for you.
 
 Next, you might want to import your goods data. Please jump to [Data imports](./data-import.md) if you don't want to stop.
 

docs/guide/cookbook/setup.md

@@ -4,17 +4,15 @@
 
 In Vue Storefront there are two types of components:
 
-- In Vue Storefront there are two types of components:
-
-- **Core components:** In core components, we implemented all basic business logic for an eCommerce shop, so you don't need to write it from scratch by yourself. You can make use of them in your themes, where all you need to do is styling and creating the HTML markup. Every core component provides an interface to interact with. This interface can be extended or overwritten in your theme if you need to. Core components should be injected to themes as mixins.They contain only business logic—HTML markup and styling should be done in themes. You can usually find core components inside the `components` folder of every module.
+- **Core components:** In core components, we implemented all the basic business logic for an eCommerce shop, so you don't need to write it from scratch by yourself. You can make use of them in your themes, where all you need to do is styling and creating the HTML markup. Every core component provides an interface to interact with. This interface can be extended or overwritten in your theme if you need to. Core components should be injected to themes as mixins.They contain only business logic—HTML markup and styling should be done in themes. You can usually find core components inside the `components` folder of every module.
 
 - **Theme components:** Theme components are what you really see in the app. They can inherit business logic from core components or be created as theme-specific components. All CSS, HTML, and ui-specific logic should be placed in theme.
 
 ## Working with core components
 
 First, **override core components only when you're adding ui-agnostic features to the core.** The correct approach for using core components in your theme is thinking of them as an external API. You can inherit the functionalities and extend them in theme but never change it in core.
 
-**When you're modifying the core component, never change the component's API** (data and methods exposed by the component for themes). Such changes would break the themes using this core component.
+**When you're modifying the core component, never change the component's API** (data and methods exposed by the component for themes). Such changes would break the theme using this core component.
 
 ## Using core components in your theme
 

docs/guide/core-themes/core-components.md

@@ -6,7 +6,7 @@ This feature can be very useful for non-standard rendering scenarios like:
 
 - Generating the XML output
 - Generating the AMPHTML pages
-- generating widgets without `<head>` section
+- Generating widgets without `<head>` section
 
 ## How it works
 
@@ -188,6 +188,6 @@ Please note that the `context` contains a lot of interesting features you can us
 
 ## Output compression
 
-HTML Minifier has been added to Vue Storefront 1.11. To enable this feature please switch the `config.server.useHtmlMinifier`. You can set the specific configuration of the `htmlMinifier` using the `config.server.htmlMinifierOptions`. Read more on the [available configuration](https://www.npmjs.com/package/html-minifier). The minified output is tthen being cached by `SSR Output cache` mechanism.
+HTML Minifier has been added to Vue Storefront 1.11. To enable this feature please switch the `config.server.useHtmlMinifier`. You can set the specific configuration of the `htmlMinifier` using the `config.server.htmlMinifierOptions`. Read more on the [available configuration](https://www.npmjs.com/package/html-minifier). The minified output is then being cached by `SSR Output cache` mechanism.
 
-Output compression has been also enabled (if the `src/modules/server.ts` contains the `compression` module on the list). By default it works just for produdction builds. It uses the `gzip` compression by default. [Read more about the `compression` module](https://www.npmjs.com/package/compression) that we're using for this implementation.
+Output compression has been also enabled (if the `src/modules/server.ts` contains the `compression` module on the list). By default it works just for production builds. It uses the `gzip` compression by default. [Read more about the `compression` module](https://www.npmjs.com/package/compression) that we're using for this implementation.

docs/guide/core-themes/layouts.md

@@ -13,7 +13,7 @@ The service-worker source code for `vue-storefront` is pre-compiled with Babel p
 
 After changing anything in `{themename}/service-worker/index.js`, despite you're in `yarn dev` auto  reloading mode, you need to do two things:
 
-1.Recompile app (which regenerates service-worker):
+1. Recompile app (which regenerates service-worker):
    `yarn build`
 
 2. Reload Service Worker in Dev Tools (in Chrome, just click **"Unregister"** and reload the page, and a new Service Worker will be installed).

docs/guide/core-themes/service-workers.md

@@ -3,10 +3,10 @@
 ## What are the data resolvers?
 
 The `data resolvers` are the way of manage the network/api calls and split them from the rest of application. All of available `data resolvers` you can find in the `core/data-resolver` directory.
-If you want to trigger a network calls, you should create a new `data resolver`, and import it in the place where it's needed.
+If you want to trigger a network call, you should create a new `data resolver`, and import it in the place where it's needed.
 
 ## How to create a data resolver
-First of all, please create a types for it under the namespace `DataResolver`, then just create a new data resolver like this example below:
+First of all, please create a type for it under the namespace `DataResolver`, then just create a new data resolver like this example below:
 
 
 ```js

docs/guide/data-resolvers/introduction.md

@@ -16,7 +16,7 @@ Registering the new user by given user data (`customer`) and `password`.
 
 #### `updateProfile: (userProfile: UserProfile) => Promise<Task>`
 
-It updates the the current logged user profile (`userProfile`).
+It updates the current logged user profile (`userProfile`).
 
 #### `getProfile: () => Promise<Task>`
 

docs/guide/data-resolvers/user-service.md

@@ -95,7 +95,7 @@ We managed to do this by making extensive use of the browser cache. 
 - **For the static assets** (only prod) we use the [sw-precache](https://github.com/GoogleChromeLabs/sw-precache) plugin (config can be found in `core/build/webpack.prod.sw.config.js` ). They are cached in Service Worker and can be inspected under the `Application/Cache Storage` tab of your Developer Tools.
 
 ![cache](https://cdn-images-1.medium.com/max/1200/1*BHVzt7oCIxcM3bNPZriKmw.png)
-*Here you can find cached static assets. Please notice that Service Worker works only in production mode.*
+*Here you can find cached static assets.*
 
 :::warning
 Please note that Service Worker works only in production mode.
@@ -116,7 +116,7 @@ You may not believe me but this is all you need to know to start working with Vu
 - [Project structure explained](https://docs.vuestorefront.io/guide/basics/project-structure.html)
 - [Configuration file explained](https://docs.vuestorefront.io/guide/basics/configuration.html)
 - [Extending Vue Storefront](https://docs.vuestorefront.io/guide/extensions/introduction.html)
-- [How to contribute](https://docs.vuestorefront.io/guide/basics/contributing.html#branches)
+- [How to contribute](https://docs.vuestorefront.io/guide/basics/contributing.html#how-to-contribute)
 
 ## Video with training
 You can also watch a video recording from 4th Vue Storefront hackathon with free introduction training

docs/guide/general/introduction.md

@@ -61,7 +61,7 @@ As you can see, it's just an **IT** or **DE** store code that is added to the ba
 In the result, you should get:
 
 - _vue_storefront_catalog_it_ - populated with the "it" store data
-- _vue_storefront_catalog_de_ - populated with the "it" store data
+- _vue_storefront_catalog_de_ - populated with the "de" store data
 - _vue_storefront_catalog_ - populated with the "default" store data
 
 Then, to use these indices in Vue Storefront, you should index the database schema using the `vue-storefront-api` db tool (use only if using mage2vuestorefront!):
@@ -190,7 +190,7 @@ By default, the language / store is switched by the URL prefix:
 
 - `http://localhost:3000` is for the default store
 - `http://localhost:3000/it` will switch the store to the Italian one
-- `http://localhost:3000/de` will switch the store to the German one one
+- `http://localhost:3000/de` will switch the store to the German one
 
 General URL format is:
 `http://localhost:3000/{storeCode}`