Commit Graph

471 Commits

Author SHA1 Message Date
olivermrbl
6dafb51547 Merge branch 'master' into develop 2023-01-11 16:46:32 +01:00
github-actions[bot]
3b632c5130 chore(docs): Generated API Reference (#2991)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
2023-01-11 17:43:03 +02:00
Oliver Windall Juhl
0d9e3e86dd docs: Temporarily remove note on peer deps in documentation (#2988)
* docs: Temporarily remove note on peer deps in documentation

* Update docs/content/advanced/backend/plugins/create.md

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

Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2023-01-11 17:37:00 +02:00
Shahed Nasser
4156e280ab docs: added publishable API keys documentation pages (#2972)
* docs: added publishable api keys docs

* Update docs/content/advanced/admin/manage-publishable-api-keys.mdx

Co-authored-by: Frane Polić <16856471+fPolic@users.noreply.github.com>

* Update publishable-api-keys.mdx

* Update docs/content/advanced/storefront/use-sales-channels.mdx

Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>

* added note in admin how-to guide

* added note in conceptual guide

* Update docs/content/advanced/backend/publishable-api-keys/index.md

Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>

* small fixes

Co-authored-by: Frane Polić <16856471+fPolic@users.noreply.github.com>
Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>
2023-01-11 17:36:51 +02:00
Shahed Nasser
c94ce03aa2 docs: added upgrade guide for 1.7.3 (#2968)
* docs: added upgrade guide for 1.7.3

* remove sales channel note
2023-01-11 17:36:29 +02:00
Shahed Nasser
21b1ae53e4 docs: changed links on the homepage (#2981)
* docs: changed homepage

* added missing import

* added related links

* added a link to the user guide on homepage
2023-01-10 21:09:11 +02:00
olivermrbl
abb98f99dd Merge branch 'master' into develop 2023-01-10 19:23:34 +01:00
Oliver Windall Juhl
32b038fc3f feat(medusa): Reliable retrying of jobs (#2947) 2023-01-09 11:56:29 +01:00
Binzi
0f039a087a docs: Correct import products url (#2960)
Fixes broken URL in `introduction.md`
2023-01-09 10:21:56 +02:00
Shahed Nasser
39c834e043 docs: small fixes based on friction log (#2954)
* docs: small fixes

* removed python command
2023-01-06 11:40:18 +02:00
Shahed Nasser
8ba27a2e28 docs: changed details related to new payment method signatures (#2876)
* docs: changed details related to new method signatures

* updated the information regarding update_requests

* small changes to the text

* lint fixes

* fixed constructor

* fixes based on review
2023-01-05 11:55:27 +02:00
Shahed Nasser
af7e67e827 docs: added gift card documentation guides (#2939) 2023-01-04 18:16:51 +02:00
github-actions[bot]
c62e309629 chore(docs): Generated API Reference (#2935)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
2023-01-03 16:26:45 +02:00
github-actions[bot]
cd32795595 chore(docs): Generated API Reference (#2927)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
2023-01-03 10:40:03 +02:00
Yessica Bao
663a0d1a59 docs: fix wrong key for order placed in sendgrid docs (#2923)
Hello!

I just found out that the key in plugin options for Order Placed `order.placed` is wrong. It should be `order_placed_template` instead.
2023-01-03 10:27:27 +02:00
Shahed Nasser
45f7ed8d1b docs: updated steps in MinIO documentation (#2922) 2023-01-02 17:33:10 +02:00
Shahed Nasser
d1b4b11ff6 chore(docs): added eslint to lint documentation code blocks (#2920)
* docs: added rule for code length

* chore: fixes based on vale errors

* changed to use eslint

* fixes using eslint

* added github action for documentation eslint

* changed allowed max-length

* fixed incorrect heading level

* removed comment
2022-12-30 18:44:46 +02:00
Shahed Nasser
99add15fc3 docs: added a note about watching changes (#2917) 2022-12-29 16:51:30 +02:00
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