Commit Graph

453 Commits

Author SHA1 Message Date
Shahed Nasser
3d4e71aa45 docs: added a section to the troubleshooting guide (#2916) 2022-12-29 16:38:33 +02:00
Shahed Nasser
123d910ef6 docs: added Manage Customers documentation (#2911)
* docs: added Manage Customers documentation

* fixed link
2022-12-28 19:36:18 +02:00
Shahed Nasser
f89759f069 docs: added Implement Customer Profiles documentation (#2910) 2022-12-28 17:43:35 +02:00
Shahed Nasser
800059bf6e docs: added Customers conceptual guide (#2908) 2022-12-27 18:01:59 +02:00
Akarsh Jain
48baf48eff docs: add git as in the prerequisites section of the Quickstart Guide (#2892)
* docs: Added git as in the prerequisites section of the Quickstart Guide

Fixes: #2850

* added divider

Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2022-12-27 15:21:20 +02:00
github-actions[bot]
d93d337df7 chore(docs): Updated API Reference (#2903)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2022-12-26 16:30:38 +00:00
Shahed Nasser
035790606e docs: added missing sections (#2901)
* docs: added a link to the quickstart guide

* docs: added env variables section
2022-12-26 17:01:23 +02:00
Shahed Nasser
2916ff9861 docs: added troubleshooting docs (#2900) 2022-12-26 16:19:10 +02:00
Shahed Nasser
b0ebfd6bcf docs: added dividers + see also section (#2899) 2022-12-26 15:52:08 +02:00
Shahed Nasser
b0e5769e27 docs: added a feedback component in quickstart guides (#2894)
* docs: added a feedback component in quickstart guides

* docs: added feedback to admin docs
2022-12-23 16:54:18 +02:00
github-actions[bot]
a32a2c4cf1 chore(docs): Generated Services Reference (automated) (#2891)
Co-authored-by: kodiakhq[bot] <kodiakhq[bot]@users.noreply.github.com>
2022-12-23 10:20:47 +02:00
Shahed Nasser
bf200c5528 docs: added order edit documentation pages (#2885) 2022-12-22 19:24:44 +02:00
Shahed Nasser
c414dd5498 docs: added schema option (#2880) 2022-12-22 17:15:12 +02:00
Shahed Nasser
87256e81b3 docs: added an upgrade guide for v1.7.1 (#2868)
* docs: added an upgrade guide for 1.7.1

* docs: added more required changes for the release

* docs: removed link to payment provider docs

* docs: reordered upgrade guides in desc order

* added export to code snippet

* added details about update_request property

* fixed the text

* added link to scheduled jobs docs
2022-12-22 17:13:20 +02:00
github-actions[bot]
4814045036 chore(docs): Generated API Reference (#2882)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2022-12-22 17:09:49 +02:00
olivermrbl
51c61f401e Merge branch 'master' into develop 2022-12-22 15:45:16 +01:00
Shahed Nasser
c78e78de28 docs: fixed typo in upgrade guide v1.7 (#2879) 2022-12-22 15:30:18 +02:00
Shahed Nasser
f4c9a4698f docs: added a note about running migrations (#2875)
* docs: added a note about running migrations

* docs: fixed link
2022-12-22 12:12:21 +02:00
olivermrbl
5ae319004f Merge branch 'master' into develop 2022-12-22 10:43:29 +01:00
Shahed Nasser
7c0ae7f6ba docs: added customize medusa admin docs (#2870) 2022-12-21 19:23:16 +02:00
Debashis Biswal
34b5b63ee0 docs: add test medusa cli after installation in set up dev env docs (#2866)
* Update Set up your development doc for Medusa CLI section

* Remove auto changes by VS code.

* Update docs/content/tutorial/0-set-up-your-development-environment.mdx

Co-authored-by: Shahed Nasser <shahednasser@gmail.com>

Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2022-12-21 11:51:38 +02:00
Jon Jahr
355228c449 docs: add a note about running migrations after changing database type (#2699)
* Add note to run migrations

I think it will be helpful to remind newbies to run migrations after they change their `database_type`.  I'm a newbie and today I got stuck for a while because I didn't know I had to run migrations after I changed from `sqlite` to `postgres`.

* Add H3 header "Changing Database Type"
2022-12-21 10:43:29 +02:00
Shahed Nasser
907f7f83d8 docs: added user guide for custom gift cards (#2862) 2022-12-20 17:51:06 +02:00
chemicalkosek
ea4c6b8b18 [docs] Update gatsby occurance to vite (#2860) 2022-12-20 12:42:47 +00:00
Patrick
a027d5ff9e chore(oas): PascalCase for schemas + remove x-resourceId (#2847)
### What

Rename all JSDoc OAS `@schema` and `$ref: #/components/schemas/` from snake_case to PascalCase, `foo_bar -> FooBar`

Extra scope: Remove `x-resourceId` from JSDoc OAS.

### Why

Classes use PascalCase as a convention but the OAS @schemas describing them were using snake_case. OAS code generators tend to use the schema name when generating typed models.

In order to avoid mismatch between source code, the OAS, and the generated client code, it is advised to align OAS @schemas formatting to the classes they represent.

Extra scope: x-resourceId is not a widely used OAS property. It's current usage in our OAS does not provide additional value. Therefore, we recommend to remove it in order to have one less item to maintain.

### How

Good old search & replace. Regex search to further make sure we didn't miss any.

The scope is limited to `@schema` definition and their usage in `$ref: #/components/schemas/`.

### Test

* Ran OAS validator.
* Ran docs build script.

Expect no visible changes to the documentation.

Resolves: CORE-852, CORE-859
2022-12-20 10:58:57 +00:00
Philip Korsholm
79cddc23da feat(medusa-file-s3): Allow all AWS options in config (#2809) 2022-12-20 10:01:30 +01:00
Oliver Windall Juhl
ba6bb3e54b feat(medusa): Extract cron job logic to its own service (#2821)
**What**
Extract cron job logic from the `EventBusService` to its own service `JobSchedulerService`

**Why**
Preliminary step to extracting the event bus into a module

**Tests**
Tested with a local installation of Medusa

Resolved CORE-918
2022-12-19 19:04:46 +00:00
Shahed Nasser
3fb9362d0e docs: added region-related documentation pages (#2845)
* docs: added region doc pages

* docs: small fixes
2022-12-19 18:54:26 +02:00
Shahed Nasser
4ddbde3594 docs: changed postgres plan using in heroku docs (#2827) 2022-12-19 10:53:27 +02:00
Shahed Nasser
f2cb0cf683 docs: added upgrade guide for admin (#2816) 2022-12-16 11:26:30 +02:00
Shahed Nasser
e5e13cc40e docs: added order claim documentation (#2805) 2022-12-14 20:25:12 +02:00
Shahed Nasser
e2b7f77ba9 docs: fix id used in endpoint path in OAS (#2795)
* docs: fix id used in endpoint path in OAS

* docs: small fixes to OAS comments

* revert changes in core package

* undo changes in core files
2022-12-14 11:54:31 +02:00
Shahed Nasser
319bcc71b0 docs: updated event reference (#2791)
* docs: updated events reference

* docs: added noCopy metadata option for code blocks
2022-12-13 18:14:53 +02:00
Shahed Nasser
52a8e90aac chore(docs): Generated API reference (#2788) 2022-12-13 12:52:58 +02:00
Shahed Nasser
a77b4a1b7e docs: changed the steps to run tests in local dev (#2786) 2022-12-13 12:47:21 +02:00
github-actions[bot]
e174443ecf chore(docs): Generated JS Client Reference (automated) (#2780)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2022-12-13 12:40:33 +02:00
Shahed Nasser
76d35a1350 docs: made changes to CORS usage/config (#2784) 2022-12-13 12:32:51 +02:00
Shahed Nasser
7227c1539b docs: added a note about using Yarn for installation (#2778)
* docs: added a note about yarn being faster

* docs: fixed env variable used in admin deployment guide

* docs: fixed the use of noReport with npm2yarn
2022-12-13 11:52:55 +02:00
Shahed Nasser
6c796bf582 docs: added a minimum Node.js version for admin (#2779)
* docs: added a note about min node version in admin

* docs: added a link to Vite documentation
2022-12-13 11:52:37 +02:00
Shahed Nasser
beecd4947d docs: added an upgrade guide for 1.7.0 (#2750) 2022-12-13 10:36:52 +01:00
Caleb Rogers
6b51dd0168 docs: update environment variable used in admin's deploy guides (#2748)
* docs: Update netlify deploy readme for clarity

It was unlcear why "Gatsby" was mentioned in the env name for the server URL. Also, the code shows precedence given to `MEDUSA_BACKEND_URL` now:

```
    __MEDUSA_BACKEND_URL__: JSON.stringify(
      env.MEDUSA_BACKEND_URL ||
        // Backwards-compat with Gatsby.
        env.GATSBY_MEDUSA_BACKEND_URL ||
        env.GATSBY_STORE_URL ||
        ""
    ),
```

Therefore, this should be indicated in the documentation.

* Update docs/content/deployments/admin/deploying-on-netlify.md

* Update deploying-on-netlify.md

Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2022-12-13 10:16:01 +02:00
Caleb Rogers
9021037397 docs: use correct publish directory for netlify deploy (#2741)
* Use correct publish directory for netlify deploy

Netlify automatically sets the Publish directory as "dist," but the netlify admin app's `build` command outputs files to `public`.

* Update docs/content/deployments/admin/deploying-on-netlify.md

Co-authored-by: Shahed Nasser <shahednasser@gmail.com>

* Netlify CLI instructions updated to match UI

* Update docs/content/deployments/admin/deploying-on-netlify.md

* Update docs/content/deployments/admin/deploying-on-netlify.md

* Update deploying-on-netlify.md

Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2022-12-13 10:12:58 +02:00
Shahed Nasser
64a4dcc53b docs: fixed tabs in create-medusa-app (#2762) 2022-12-12 13:27:48 +02:00
Shahed Nasser
0d1e73f152 docs: added Klarna documentation (#2746) 2022-12-08 20:26:35 +02:00
Shahed Nasser
a57177ded5 docs: redesigned code blocks (#2745)
* docs: redesigned code blocks to include titles

* docs: added a title where necessary
2022-12-08 18:52:54 +02:00
Shahed Nasser
8efae2dfcf docs: added details about admin analytics in usage documentation (#2733) 2022-12-06 18:14:07 +02:00
Shahed Nasser
2ffeaf567f docs: delete unused doc files (#2732) 2022-12-06 18:13:38 +02:00
Shahed Nasser
7363cae339 docs: Added Manage Discounts using Admin APIs doc (#2730) 2022-12-06 16:43:13 +02:00
Shahed Nasser
f19e4de636 docs: added Use Discounts in Checkout documentation (#2717) 2022-12-02 16:10:54 +02:00
Shahed Nasser
c729921180 docs: fixes to discounts documentation percentage (#2711)
* docs: fixes to discounts documentation

* docs: added a note about regions for fixed discount
2022-12-01 17:37:56 +02:00