From 39c834e0432070dc8da0a87529b9298514ba2200 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Fri, 6 Jan 2023 11:40:18 +0200 Subject: [PATCH] docs: small fixes based on friction log (#2954) * docs: small fixes * removed python command --- docs/content/admin/quickstart.mdx | 6 +++++- docs/content/homepage.mdx | 2 +- docs/content/introduction.md | 6 +++--- docs/content/quickstart/quick-start-docker.mdx | 12 +----------- docs/content/quickstart/quick-start.mdx | 10 ---------- docs/content/usage/create-medusa-app.mdx | 6 ++++-- 6 files changed, 14 insertions(+), 28 deletions(-) diff --git a/docs/content/admin/quickstart.mdx b/docs/content/admin/quickstart.mdx index 9c164ad337..ccfd938266 100644 --- a/docs/content/admin/quickstart.mdx +++ b/docs/content/admin/quickstart.mdx @@ -100,7 +100,7 @@ By default, the admin runs on port 7000. So, in your browser, go to `localhost:7 Use your Medusa admin’s user credentials to log in. -:::tip +### Demo Credentials If you installed the demo data when you installed the Medusa server by using the `--seed` option or running: @@ -110,6 +110,10 @@ npm run seed You can use the email `admin@medusa-test.com` and password `supersecret` to log in. +:::info + +Passwords in Medusa are hashed using the [scrypt-kdf](https://www.npmjs.com/package/scrypt-kdf). The password hash is then stored in the database. + ::: --- diff --git a/docs/content/homepage.mdx b/docs/content/homepage.mdx index b99924ad24..c66f233f9e 100644 --- a/docs/content/homepage.mdx +++ b/docs/content/homepage.mdx @@ -37,7 +37,7 @@ Learn about Medusa basic features and kickstart your ecommerce project. light: '/img/dev-env-icon.svg', dark: '/img/dev-env-icon-dark.svg' }, - description: 'Set up your dev environment.' + description: 'Prepare your setup for advanced development.' } }, { diff --git a/docs/content/introduction.md b/docs/content/introduction.md index df9764eed9..9317d1541b 100644 --- a/docs/content/introduction.md +++ b/docs/content/introduction.md @@ -2,13 +2,13 @@ ## Architecture -Medusa is composed of three components: The headless backend, the admin dashboard, and the storefront. +Medusa is composed of three components: The Medusa server, the admin dashboard, and the storefront. ![Medusa's Architecture](https://res.cloudinary.com/dza7lstvk/image/upload/v1667999772/Medusa%20Docs/Diagrams/ZHvM2bu_td4rnx.png) -### Headless Backend +### Medusa Server -This is the main component that holds all the logic and data of the store. Your admin dashboard and storefront interact with the backend to retrieve, create, and modify data through REST APIs. +The Medusa server is a headless backend built on Node.js. This is the main component that holds all the logic and data of the store. Your admin dashboard and storefront interact with the backend to retrieve, create, and modify data through REST APIs. Your Medusa server will include all functionalities related to your store’s checkout workflow. That includes cart management, shipping and payment providers, user management, and more. It also allows you to configure your store including your store’s region, tax rules, discounts, gift cards, and more. diff --git a/docs/content/quickstart/quick-start-docker.mdx b/docs/content/quickstart/quick-start-docker.mdx index c245445e51..c4d38500f8 100644 --- a/docs/content/quickstart/quick-start-docker.mdx +++ b/docs/content/quickstart/quick-start-docker.mdx @@ -81,19 +81,9 @@ Once done, your server will be accessible at `http://localhost:9000`. You can test out your server using tools like Postman or by sending a cURL request: ```bash noReport -curl -X GET localhost:9000/store/products | python -m json.tool +curl -X GET localhost:9000/store/products ``` -:::note - -This command uses Python to format the result of the request better in your command line. If you don't want to use Python you can simply send a request without the formatting: - -```bash noReport -curl localhost:9000/store/products -``` - -::: - --- ## Additional steps diff --git a/docs/content/quickstart/quick-start.mdx b/docs/content/quickstart/quick-start.mdx index f3dc1c6ba4..e74085631b 100644 --- a/docs/content/quickstart/quick-start.mdx +++ b/docs/content/quickstart/quick-start.mdx @@ -66,20 +66,10 @@ If you run into any errors while installing the CLI tool, check out the [trouble After these three steps and in only a couple of minutes, you now have a complete commerce engine running locally. You can test it out by sending a request using a tool like Postman or through the command line: -```bash noReport -curl localhost:9000/store/products | python -m json.tool -``` - -:::note - -This command uses Python to format the result of the request better in your command line. If you don't want to use Python you can simply send a request without the formatting: - ```bash noReport curl localhost:9000/store/products ``` -::: - --- ## Additional Steps diff --git a/docs/content/usage/create-medusa-app.mdx b/docs/content/usage/create-medusa-app.mdx index adff4da8cd..60aa0354d1 100644 --- a/docs/content/usage/create-medusa-app.mdx +++ b/docs/content/usage/create-medusa-app.mdx @@ -42,9 +42,11 @@ In your terminal, run the following command: You’ll then be asked to enter the name of the directory you want the project to be installed in. You can either leave the default value `my-medusa-store` or enter a new name. -### Choose Medusa Starter +### Choose Medusa Server Starter -Next, you’ll be asked to choose the Medusa starter used to install the Medusa server. You can either pick the default Medusa starter, the Contentful starter or enter a starter URL by choosing `Other`: +Next, you’ll be asked to choose the Medusa starter. The Medusa Server is created from a starter template. By default, it is created from the `medusa-starter-default` template. + +You can either pick the default Medusa starter, the Contentful starter or enter a starter URL by choosing `Other`: ```bash noReport ? Which Medusa starter would you like to install? …