modified docusaurus admonitions to docs

This commit is contained in:
Shreedhar Hegde
2022-04-25 16:25:10 +05:30
parent 01114b42a4
commit 1d138709e2
16 changed files with 27 additions and 25 deletions

View File

@@ -66,7 +66,7 @@ git push origin main
Within a couple of minutes, your Medusa Admin is live and running on Netlify.
:::note
:::tip
If you experience CORS issues in your new setup, you might need to add your admin url as part of the ADMIN_CORS environment variable in your server setup.

View File

@@ -87,7 +87,7 @@ Navigate to the top-right dropdown **Create** and select **Apps**.
Choose **GitHub** or **GitLab** and select the repository that holds your Medusa project. Check **Autodeploy code changes**, if you want DigitalOcean to deploy on every push to your repository.
:::note
:::tip
It's important, that DigitalOcean is pointing to the directory holding the Medusa store engine as it is only this which that will be deployed (If you followed the quickstart guide this will simply be the created project, and if you used the npx command this will be the backend folder inside of the newly created project).
@@ -108,7 +108,7 @@ JWT_SECRET=your-jwt-secret
COOKIE_SECRET=your-cookie-secret
```
:::note
:::tip
Make sure to use actual secrets in a production environment

View File

@@ -68,7 +68,7 @@ heroku git:remote -a medusa-test-app
Medusa requires a Postgres database and a Redis instance to work. These are added through the Heroku CLI using the following commands.
:::note
:::tip
In this below example, we initialize the resources on free plans. This is not a valid configuration for a production environment.
@@ -110,7 +110,7 @@ heroku config:set JWT_SECRET=your-super-secret
heroku config:set COOKIE_SECRET=your-super-secret-pt2
heroku config:set NPM_CONFIG_PRODUCTION=false
```
:::note
:::tip
Make sure to use actual secrets in a production environment.

View File

@@ -87,7 +87,7 @@ JTW_SECRET=something_secret_jwt
COOKIE_SECRET=something_secret_cookie
```
:::note
:::tip
Make sure to use actual secrets in a production environment.

View File

@@ -76,7 +76,7 @@ npm run migrate:contentful --file contentful-migrations/update-page-module-valid
To use your new Rich Text module **Content > Page > About**, and click **Add Content > Page**. You will now make use of the new Rich Text module to add some more details about your store. You can write your own text or use the text provided below if you just want to copy/paste.
:::note About Medusa
:::info About Medusa
Medusa is an open-source headless commerce engine for fast-growing businesses. Getting started with Medusa is very easy and you will be able to start selling online with a basic setup in no time, however, the real power of Medusa starts showing up when you add custom functionality and extend your core to fit your needs.

View File

@@ -77,7 +77,7 @@ class MyService extends NotificationService {
export default MyService;
```
:::note Note
:::note
A notification service must have a static property called `identifier` this is used to determine which classes are called when subscribing to different events. In this case the service identifier is `my-service` so to subscribe to notifications you must use:
`notificationService.subscribe([eventname], "my-service")`

View File

@@ -46,7 +46,7 @@ Then configure your `medusa-config.js` to include the plugin alongside the requi
The two access keys in the options are the ones created in the previous section.
:::note
:::tip
Make sure to use an environment variable for the secret key in a live environment.

View File

@@ -78,7 +78,7 @@ https://[bucket].s3.[region].amazonaws.com
The two access keys in the options are the ones created in the previous section.
:::note
:::tip
Make sure to use an environment variable for the secret key in a live environment.

View File

@@ -41,7 +41,7 @@ Then configure your `medusa-config.js` to include the plugin alongside the requi
In the above options, a `spaces_url` is included. This can be found in your Space overview. The `bucket` should point to the name you gave your Space. The `endpoint` identifies the region in which you created the Space. And finally the two keys are the ones created in the previous section.
:::note
:::tip
Make sure to use an environment variable for the secret key in a live environment.