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
Shahed Nasser
8cb53da34e
docs: fix medusa-react guide + specify react-query version ( #5918 )
...
* docs: fix medusa-react guide by adding missing link
* fix link
* add v4.22 as the supported version of react-query
2023-12-18 16:01:24 +02:00
Sujal Gurung
bd60efbe65
docs: set rejectUnauthorized based on condition ( #5907 )
...
The general guide for hosting the server tells users to set `ssl.rejectUnauthorized` to false for production environments. However, the provided code snippet doesn't check the environment while setting the value. Directly pasting it into `medusa-config.js` will cause database connection attempts made from a development environment to be rejected and you can't even login to the admin account.
The change only sets the ssl property to false if the environment is a non-development one. ~I got this code suggestion from the Kapa bot on discord so not sure if this is the best way to do this.~ This code is taken from the [configuration docs](https://docs.medusajs.com/development/backend/configurations#database_extra ) themselves.
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com >
2023-12-18 12:27:10 +00:00
Shahed Nasser
ddc6cc13a0
docs: add TSDoc for payment processor + generate docs ( #5917 )
...
* added tsdocs for payment processor
* generated reference for payment processor
2023-12-18 14:02:18 +02:00
Shahed Nasser
e63f4e6c7a
docs: fix wishlist route ( #5914 )
2023-12-18 13:47:15 +02:00
IdekDude
25dd570578
Changed 'duplicate' to 'delete' in "Delete a Variant" Section ( #5823 )
...
References [Issue 5787](https://github.com/medusajs/medusa/issues/5787 )
2023-12-18 09:36:23 +00:00
Sujal Gurung
60f86c477e
docs: update Railway pricing info in deploy guide ( #5908 )
...
Railway got rid of their free tier in [June](https://blog.railway.app/p/introducing-trial-hobby-pro-plans )
2023-12-18 08:53:17 +00:00
Shahed Nasser
a34fe9bfe3
docs: updated digital ocean spaces guide ( #5900 )
...
* docs: updated digital ocean spaces guide
* fix example
2023-12-15 17:25:18 +02:00
Shahed Nasser
525ae6d728
docs: added missing service method in digital products recipe ( #5899 )
...
* docs: added missing service method in digital products recipe
* fix lint
2023-12-15 15:40:05 +02:00
Shahed Nasser
11b1a61969
docs: fixes to digital products recipe ( #5897 )
...
* docs: fixes to digital products recipe
* fix lint errors
2023-12-15 12:39:40 +02:00
github-actions[bot]
2d127a4c67
chore(docs): Generated References ( #5881 )
...
Generated the following references:
- `EventBusTypes`
- `IPricingModuleService`
- `ModulesSdkTypes`
- `PriceListWorkflow`
- `fulfillment`
- `js_client`
- `medusa`
- `modules`
- `pricing`
- `services`
- `types`
- `workflows`
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com >
2023-12-14 18:28:23 +00:00
Shahed Nasser
33dc7645d6
docs: fix upgrade guide release notes link ( #5879 )
2023-12-14 17:07:57 +02:00
Zarar Siddiqi
bbee9b4c53
docs: Add discount created event ( #5850 )
...
* Emit event when discount code created.
* Documentation for discount.created event.
* add patch changeset
* Cleaner code, avoid array indexing.
* Revert "Documentation for discount.created event."
This reverts commit 9447f4a171dd55ac8a550beeb403cb7404a18df2.
* Docs for discount.created event.
2023-12-14 15:54:31 +01:00
Riqwan Thamir
ae53a66273
docs: update docs changes for rules_count from number_rules ( #5855 )
...
* chore: add docs changes for rules_count from number_rules
* change diagrams
* undo linting
* fix lint error
---------
Co-authored-by: Shahed nasser <shahednasser@gmail.com >
2023-12-14 15:53:02 +01:00
Shahed Nasser
a6c8490fc3
docs: updates for v1.19 ( #5868 )
...
* docs: updates for v1.19
* Update www/apps/docs/content/upgrade-guides/medusa-core/1-19.mdx
Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com >
* Update www/apps/docs/content/upgrade-guides/medusa-core/1-19.mdx
Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com >
---------
Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com >
2023-12-14 15:52:41 +01:00
Shahed Nasser
1c6c759aa8
docs: added a troubleshooting section for --db-url option ( #5872 )
...
* docs: added a troubleshooting section for --db-url option
* fix vale error
2023-12-14 14:59:07 +02:00
Shahed Nasser
edc49bfe1d
docs: update required Node.js version for Next.js starter ( #5859 )
2023-12-13 15:12:14 +02:00
Sajarin M
4710c8ba7e
Fix multiple typos in medusa docs ( #5854 )
2023-12-13 10:51:48 +00:00
Ishaq Khattana
f05c20695e
docs: update local events module to fix mistyped reference to redis events module ( #5835 )
...
Co-authored-by: Shahed Nasser <shahednasser@gmail.com >
2023-12-11 13:12:22 +02:00
Shahed Nasser
a458cd144d
docs: update algolia plugin next.js details ( #5807 )
2023-12-05 15:49:52 +02:00