asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: fixed some typos and grammatical errors (#2337)

Browse Source 
* Update README.md

* Update usage.md

* Update contribution-guidelines.md

* Update quick-start-docker.md

* Update OrderService.md

* Update CartService.md

* Update README.md

* Update quick-start-docker.md

* Update usage.md

* Update CartService.md

* Update OrderService.md

* Update contribution-guidelines.md

* Update contribution-guidelines.md

* Update contribution-guidelines.md

* Update contribution-guidelines.md
This commit is contained in:
Harshavardhan Bajoria
2022-10-04 14:40:25 +05:30
committed by GitHub
parent 1024ac1a36
commit f222b7f1df
4 changed files with 19 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -14,7 +14,7 @@
</h4>
<p align="center">
An open-source composable commerce engine built for developers.
An open source composable commerce engine built for developers.
</p>
<p align="center">
<a href="https://github.com/medusajs/medusa/blob/master/LICENSE">
@@ -78,14 +78,14 @@ You can learn more about [Medusa’s architecture in our documentation](https://
- **Products and Collections APIs:** Add products with extensive customization settings and sort them into collections.
- **Region API:** Configure and manage multiple regions and currencies all from one platform.
- **Plugin API:** Easily integrate fulfillment providers, payment providers, notification services, and many other custom tools and third-party services.
- ****PriceList and Promotions APIs:**** Advanced pricing for products with conditions based on its amount in the cart or promotions and discounts.
- **Tax API:** Advanced tax configurations specific to multiple regions, with capability of specifying taxes for specific products.
- ****PriceList and Promotions APIs:**** Advanced pricing for products with conditions based on the amount in the cart or promotions and discounts.
- **Tax API:** Advanced tax configurations specific to multiple regions, with the capability of specifying taxes for specific products.
See more of the [ecommerce features on our documentation](https://docs.medusajs.com/#features).
## Roadmap
Write-ups for all features will be made available in [Github discussions](https://github.com/medusajs/medusa/discussions) prior to starting the implementation process.
Write-ups for all features will be made available in [Github discussions](https://github.com/medusajs/medusa/discussions) before starting the implementation process.
### **2022**
@@ -106,7 +106,7 @@ Write-ups for all features will be made available in [Github discussions](https
## Plugins
As a headless and extendible solution, Medusa allows you to integrate third-party services or add custom features into Medusa by installing Plugins.
As a headless and extendible solution, Medusa allows you to integrate third-party services or add custom features to Medusa by installing Plugins.
Check out [our available plugins](https://github.com/medusajs/medusa/tree/master/packages) that you can install and use instantly on your Medusa server.
@@ -114,7 +114,7 @@ Check out [our available plugins](https://github.com/medusajs/medusa/tree/master
Medusa is all about the community. Therefore, we would love for you to help us build the most robust and powerful commerce engine on the market.
Whether it is fixing bugs, improving our documentation or simply spreading the word, please feel free to join in. Please check [our contribution guide](https://github.com/medusajs/medusa/blob/master/CONTRIBUTING.md) for further details about how to contribute.
Whether it is fixing bugs, improving our documentation, or simply spreading the word, please feel free to join in. Please check [our contribution guide](https://github.com/medusajs/medusa/blob/master/CONTRIBUTING.md) for further details about how to contribute.
## Community & Support

14
docs/content/contribution-guidelines.md
View File

@@ -23,7 +23,7 @@ You’ll also find MDX files. MDX files combine the power of Markdown with React
## What You Can Contribute To
- You can contribute to the Docusaurus codebase to add a new feature or fix a bug in the documentation website.
- You can contribute to the documentation content either by fixing errors you find or adding documentation pages.
- You can contribute to the documentation content either by fixing errors you find or by adding documentation pages.
## What You Can’t Contribute To
@@ -45,7 +45,7 @@ For more details on how to contribute, check out [the contribution guidelines in
### Base Branch
When you make edit to an existing documentation page or fork the repository to make changes to the documentation, you have to create a new branch.
When you make an edit to an existing documentation page or fork the repository to make changes to the documentation, you have to create a new branch.
Documentation contributions always use `master` as the base branch.
@@ -69,17 +69,17 @@ When you add a new page to the documentation, you must add the new page in `www/
### Terminology
When the documentation page is a conceptual or overview documentation, the label in the sidebar should start with a noun.
When the documentation page is a conceptual or an overview documentation, the label in the sidebar should start with a noun.
When the documentation page is a tutorial documentation, the label in the sidebar should start with a verb. An exception of this rule are integration documentations and upgrade guides.
When the documentation page is tutorial documentation, the label in the sidebar should start with a verb. Exceptions to this rule are integration documentation and upgrade guides.
### Character Count
The character count of the sidebar item's label must be at most twenty seven characters. For the API Reference, the sidebar item's label must be at most twenty five characters.
The character count of the sidebar item's label must be at most twenty-seven characters. For the API Reference, the sidebar item's label must be at most twenty-five characters.
## Notes and Additional Information
When displaying notes and additional information in a documentation page, use [Admonitions](https://docusaurus.io/docs/markdown-features/admonitions). Make sure the type of admonition used matches the note’s importance to the current document.
When displaying notes and additional information on a documentation page, use [Admonitions](https://docusaurus.io/docs/markdown-features/admonitions). Make sure the type of admonition used matches the note’s importance to the current document.
If the note is something developers have to be careful of doing or not doing, use the `caution` or `danger` admonitions based on how critical it is.
@@ -111,7 +111,7 @@ The code snippet must be written using NPM, and the `npm2yarn` plugin will autom
<!-- vale off -->
Don't use commands in their abbrivated terms. For example, instead of `npm i` use `npm install`.
Don't use commands in their abbreviated terms. For example, instead of `npm i` use `npm install`.
<!-- vale on -->

8
docs/content/quickstart/quick-start-docker.md
View File

@@ -1,6 +1,6 @@
# Quickstart using Docker
In this document you will learn how to make a container of Medusa's app on Docker. Docker is an open source platform for building, deploying, and managing containerized applications.
In this document, you will learn how to make a container of Medusa's app on Docker. Docker is an open source platform for building, deploying, and managing containerized applications.
## Prerequisites
@@ -19,7 +19,7 @@ It is assumed that you have Docker installed on your system. You can install it
## Create Medusa Server with Docker
### 1. Clone Medusa's starter project from Github
### 1. Clone Medusa's starter project from GitHub
```bash
git clone https://github.com/medusajs/medusa-starter-default.git my-medusa-starter
@@ -58,7 +58,7 @@ If you get the error `ERROR: for postgres Cannot start service postgres: Ports
Running the above command does the following:
1. Build images for your Medusa project, a PostgreSQL database and a Redis server
1. Build images for your Medusa project, a PostgreSQL database, and a Redis server
2. Run migrations for your newly created database
@@ -103,4 +103,4 @@ You can learn more about configuring your server and loading environment variabl
- Install the [Next.js](../starters/nextjs-medusa-starter.md) or [Gatsby](../starters/gatsby-medusa-starter.md) storefronts to set up your ecommerce storefront quickly.
- Install the [Medusa Admin](../admin/quickstart.md) to supercharge your ecommerce experience with easy access to configurations and features.
- Check out the [API reference](https://docs.medusajs.com/api/store) to learn more about available endpoints available on your Medusa server.
- Install [plugins](https://github.com/medusajs/medusa/tree/master/packages) for features like Payment, CMS, Notifications, among other features.
- Install [plugins](https://github.com/medusajs/medusa/tree/master/packages) for features like Payment, CMS, and Notifications, among other features.

2
docs/content/usage.md
View File

@@ -2,7 +2,7 @@
<!-- vale docs.We = NO -->
This document gives an overview of Medusa’s optional collected usage information, how it helps Medusa become a better platform, and how developers can opt out of this feature.
This document gives an overview of Medusa’s optional collected usage information, how it helps Medusa become a better platform, and how developers can opt-out of this feature.
## Overview