github-actions[bot]
7fe164bc1d
chore(docs): Generated References ( #6904 )
...
Generated the following references:
- `inventory`
- `js_client`
- `medusa`
- `medusa_config`
- `medusa_react`
- `modules`
- `payment`
- `pricing`
- `product`
- `services`
- `stock_location`
- `tax_calculation`
- `types`
- `workflows`
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com >
2024-04-02 10:06:06 +00:00
Raiyan Sarker
9d466717f4
docs(plugin): paypal integration missing createOrder callback ( #6401 )
...
This PR adds missing information in paypal plugin docs which is crucial to its use. Previously, docs didn't mention about createOrder callback that is required by PayPal sdk to connect with backend for details like currency and amount to be charged. Medusa backend responds with required id for the PayPal sdk to use. Related to https://github.com/medusajs/nextjs-starter-medusa/issues/260#issuecomment-1944157985
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com >
2024-04-02 08:10:35 +00:00
github-actions[bot]
68aa0971a2
chore(docs): Generated References ( #6896 )
...
Generated the following references:
- `inventory`
- `js_client`
- `medusa`
- `medusa_config`
- `medusa_react`
- `modules`
- `payment`
- `pricing`
- `product`
- `services`
- `stock_location`
- `tax_calculation`
- `types`
- `workflows`
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com >
2024-04-01 13:35:12 +00:00
Shahed Nasser
16860cc883
docs: added doc pages for v1.20.4 ( #6828 )
...
- Added new documentation page for Medusa Worker.
- Updated Railway deployment guide with details on Medusa Worker.
- Small adjustments to the `worker_mode` option's TSDocs.
2024-03-26 19:19:57 +00:00
Deveosys
8929b2d60b
Update example-logged-in-user.mdx ( #6780 )
...
Add authenticate() middleware to be able to get current user with req.user
2024-03-22 08:44:13 +00:00
Oli Juhl
a859b7895e
docs: Upgrade guide for v1.20.3 ( #6753 )
2024-03-20 11:12:53 +00:00
Shahed Nasser
bb87db8342
docs: prep for v2 documentation ( #6710 )
...
This PR includes documentation that preps for v2 docs (but doesn't introduce new docs).
_Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._
## Changes
- Change Medusa version in base OAS used for v2.
- Fix to docblock generator related to not catching all path parameters.
- Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules.
- Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used.
- Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment.
- Upgraded docusaurus to v3.0.1
- Added new Vale rules to ensure correct spelling of Medusa Admin and module names.
- Added new components to the `docs-ui` package that will be used in future documentation changes.
2024-03-18 07:47:35 +00:00
Shahed Nasser
d38b5eb790
docs: fix migrations path in extend entity docs ( #6645 )
2024-03-11 08:44:53 +01:00
Minh Tu Ngo
7109969874
docs: Heroku typo ( #6629 )
2024-03-08 17:01:30 +00:00
Shahed Nasser
531e9e1e94
docs: hide admin translations contribution page ( #6603 )
2024-03-06 21:25:33 +01:00
Shahed Nasser
860d56041a
docs: fixes to CLI reference ( #6530 )
2024-02-29 13:37:36 +01:00
Leonardo Cabeza
be8122bc0d
Update redis.md ( #6519 )
...
Fix ioredis options url
2024-02-27 08:45:34 +00:00
Shahed Nasser
52afc619b3
docs: typo fix in create event module reference ( #6470 )
2024-02-22 12:16:18 +01:00
Shahed Nasser
c3e30224c7
docs: add missing widget props for collections injection zones ( #6452 )
...
* docs: add missing widget props for collections injection zones
Adds missing widget props for the `product_collection.details.before` and `product_collection.details.after` injection zones.
* fix lint error
2024-02-21 07:49:30 +01:00
Shahed Nasser
68123c6ffd
docs: add missing steps to enable medusa_v2 flag ( #6406 )
2024-02-16 14:20:52 +00:00
Shahed Nasser
0d68eadf84
docs: add ignore tag to isPaymentProcessor ( #6410 )
...
- Add ignore tags to `isPaymentProcessor` method and property
- Generate payment reference to move the associated section.
2024-02-16 12:51:14 +00:00
Leonardo Cabeza
811a004c03
fix: typo in git checkout command ( #6403 )
...
typo in a git command
2024-02-15 08:34:09 +00:00
Shahed Nasser
16927469eb
docs: fixes to code snippets in Workflows documentation ( #6393 )
2024-02-14 13:25:35 +00:00
Shahed Nasser
d1f697c88e
docs: new troubleshooting guide + cors fix ( #6387 )
...
- Fixed CORS middleware to account for routes of a single path (for example, `/custom` and not just `/custom/test`).
- Added a troubleshooting guide for admin webpack errors (see issue #6375 )
2024-02-13 11:32:02 +00:00
Shahed Nasser
bc2a63782b
docs: update next.js starter docs ( #6378 )
...
* docs: update next.js starter docs
* added empty changeset
2024-02-12 14:10:08 +01:00
Nicklas Gellner
2afcf1c918
docs: clarification in text ( #6361 )
...
changed from payment to fulfillment provider in the text
2024-02-12 08:20:07 +00:00
github-actions[bot]
1d0a978ffe
chore(docs): Generated References ( #6351 )
...
Generated the following references:
- `file`
- `fulfillment`
- `inventory`
- `js_client`
- `medusa`
- `medusa_config`
- `medusa_react`
- `modules`
- `notification`
- `payment`
- `price_selection`
- `pricing`
- `product`
- `services`
- `stock_location`
- `tax`
- `tax_calculation`
- `types`
- `workflows`
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com >
2024-02-08 21:18:10 +00:00
Siddharth Kulkarni
5c6ba674fb
docs: update link to io-redis options ( #6337 )
...
…ties
Update redis.md to correct the documentation link to io-redis propoerties. Current Link was incorrect.
2024-02-07 12:55:21 +00:00
Ira
44470bf8c5
Update all curl documentation examples and references with new x-medusa-access-token header ( #6326 )
...
## What
This is to update incorrect documentation in regards to authentication to the Admin API - raised in https://github.com/medusajs/medusa/issues/6264 .
## Why
Because the current documentation has been incorrect since the September 2023 release of [v1.17.0](https://github.com/medusajs/medusa/releases/tag/v1.17.0 ), which had breaking changes to API token usage.
## How
Simple search and replace. I was asked to replace occurrences under `www/apps/docs/content/` but there were also additional places where I thought references should also be updated:
- `packages/medusa/src/api/`
- `www/apps/api-reference/`
Feel free to revert them as needed.
There is also some inconsistency between the format shown in examples e.g. `<API_TOKEN>` vs `{api_token}` vs `{access_token}`.
I have kept the format the same in all cases as the original, as surrounding documentation text would not have format updated as well. I suggest maybe reviewing the documentation and keeping to a consistent format e.g. `<API_TOKEN>`.
## Testing
I have not tested these changes. I would assume the `packages/medusa/src/api/` changes may need more thorough testing?
2024-02-07 08:41:38 +00:00
xyzones
5cabe9585f
docs: s3 The "images.domains" configuration is deprecated ( #6321 )
2024-02-06 09:57:52 +00:00
Shahed Nasser
2cebadc3a8
docs: fix title of the configuration page ( #6268 )
...
Fix the title of the configurations page which is generated by typedoc
2024-01-31 13:50:34 +00:00
github-actions[bot]
5a550e73b4
chore(docs): Generated References ( #6222 )
...
Generated the following references:
- `entities`
- `file`
- `fulfillment`
- `inventory`
- `js_client`
- `medusa`
- `medusa_config`
- `medusa_react`
- `modules`
- `notification`
- `payment`
- `price_selection`
- `pricing`
- `product`
- `search`
- `services`
- `stock_location`
- `tax`
- `tax_calculation`
- `types`
- `workflows`
Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com >
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com >
2024-01-25 18:12:27 +00:00
Shahed Nasser
b78ffedafb
docs: add a section on custom templates in SendGrid guide ( #6215 )
2024-01-25 16:47:08 +01:00
Shahed Nasser
75fd6b0c83
docs: improvements to deployment guides ( #6183 )
...
- Add a new deployment overview page giving a general overview of how a Medusa project is deployed
- Add a new section in all backend deployment guides related to the Medusa admin.
- Add a general deployment guide for the medusa admin.
- Add a general deployment guide for the Next.js starter
2024-01-24 08:22:50 +00:00
Shahed Nasser
bc79edfa67
docs: update strapi guide ( #6163 )
...
Update the Strapi guide to use [this community plugin](https://github.com/SGFGOV/medusa-strapi-repo )
Fixes #5152 and #5030
2024-01-23 09:31:09 +00:00
Shahed Nasser
9d7ed9dbaf
docs: rearrange sections in SendGrid guide ( #6165 )
...
Rearrange sections in the sendgrid plugin guide to show installation steps before templates reference.
2024-01-23 08:36:34 +00:00
Shahed Nasser
9a3326a56e
docs: fix production build error ( #6170 )
...
Fix build error in production due to incorrect link
2024-01-23 08:19:25 +00:00
peyronoscar
85efa9b910
docs: Update environment variables to match Railway variable references format ( #6145 )
2024-01-22 20:29:51 +01:00
Shahed Nasser
4792c55226
docs: migrate guides to TSDoc references ( #6100 )
2024-01-22 18:38:35 +01:00
Shahed Nasser
8c67e32d41
docs: improve admin documentation ( #6117 )
...
- Move the admin plugin's options to the Admin Configuration documentation.
- Add a section on how to change the backend URL for both development and production.
- Fix the troubleshooting section related to port forwarding.
- General fixes.
2024-01-22 15:48:33 +00:00
Vinh Nguyen
b61acf9312
fix(docs): update extend repository ( #6140 )
...
- Issue ticket https://github.com/medusajs/medusa/issues/6139
- Update document how to extend repository
2024-01-22 15:21:30 +00:00
Shahed Nasser
571b64cd16
docs: added link to next.js starter demo ( #6108 )
2024-01-17 10:31:38 +00:00
Shahed Nasser
5d1965f2fa
docs: add new troubleshooting section for create-medusa-app ( #6071 )
...
* docs: add new troubleshooting section for create-medusa-app
* small fixes
2024-01-15 13:33:53 +02:00
Shahed Nasser
5dacd4ac9f
docs: fix example of createFulfillment ( #6088 )
2024-01-15 11:20:55 +02:00
invalid w
57e00e7803
docs: typo backendUrl default url ( #6073 )
...
`http://location:9000 ` should be `http://localhost:9000 `
2024-01-12 14:11:29 +00:00
github-actions[bot]
6721633478
chore(docs): Generated References ( #6042 )
...
Generated the following references:
- `entities`
- `fulfillment`
- `inventory`
- `js_client`
- `medusa`
- `medusa_react`
- `modules`
- `payment`
- `pricing`
- `product`
- `services`
- `stock_location`
- `types`
- `workflows`
Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com >
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com >
2024-01-10 09:25:11 +00:00
Shahed Nasser
13f12e1953
docs: documentation updates for v1.20 ( #6031 )
...
* docs: documentation updates for v1.20
* fix stripe upgrade guide
* fixed vale error
* fix eslint errors
* change stripe environment variables to options
2024-01-09 19:07:24 +01:00
Shahed Nasser
18de90e603
docs: fix tsdocs following typedoc update + 1.20 release ( #6033 )
...
* docs: fix tsdocs following typedoc update + 1.20 release
* Fix OAS validation errors
* fixes to react-docs-generator
* fix content linting
2024-01-09 17:15:29 +02:00
Yessica Bao
fe81a5e49a
Update meilisearch.md ( #6026 )
...
update expire date since 2024-01-01 is past
2024-01-08 17:42:41 +00:00
Shahed Nasser
7d650771d1
docs: generate medusa-react reference ( #6004 )
...
* add new plugin for better organization
* added handling in theme for mutations and query types
* added tsdoc to hooks
* added tsdocs to utility functions
* added tsdoc to providers
* generated reference
* general fixes for generated reference
* generated api reference specs + general fixes
* add missing import react
* split utilities into different directories
* added overview page
* added link to customer authentication section
* fix lint errors
* added changeset
* fix readme
* fixed build error
* added expand fields + other sections to overview
* updated what's new section
* general refactoring
* remove unnecessary query field
* fix links
* added ignoreApi option
2024-01-05 17:03:38 +02:00
Oli Juhl
cd2855182e
docs: Update minimum node version requirement ( #5994 )
2024-01-04 13:13:41 +01:00
Minh Tu Ngo
c8f03e3a47
Update create.md ( #5978 )
...
typo
2024-01-02 09:09:39 +00:00
Shahed Nasser
5ef41bd86d
docs: fix file name for scheduled jobs ( #5972 )
2023-12-28 12:07:05 +02:00
Sujal Gurung
29bb2e4f6e
docs: rename EVENT_REDIS_URL ( #5948 )
...
fix typo in 2 places
closes medusajs/medusa#5936
2023-12-21 08:55:27 +00:00
Nicklas Gellner
699c363c25
Add link to our official Plugin directory ( #5931 )
...
Replaced the link for our awesome-Medusa-repo with a direct link to our official plugins page.
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com >
2023-12-20 10:45:21 +00:00