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
This commit is contained in:
Shahed Nasser
2022-12-30 18:44:46 +02:00
committed by GitHub
parent 99add15fc3
commit d1b4b11ff6
67 changed files with 2611 additions and 1735 deletions
+9 -9
View File
@@ -118,7 +118,7 @@ Finally, in `medusa-config.js`, add to the `plugins` array the following new ite
```jsx title=medusa-config.js
const plugins = [
//...
// ...
{
resolve: `medusa-file-s3`,
options: {
@@ -129,7 +129,7 @@ const plugins = [
secret_access_key: process.env.S3_SECRET_ACCESS_KEY,
},
},
];
]
```
### Add AWS Configurations
@@ -140,7 +140,7 @@ For example, you can pass the `region`, `access_key_id` and `secret_access_key`
```jsx title=medusa-config.js
const plugins = [
//...
// ...
{
resolve: `medusa-file-s3`,
options: {
@@ -150,10 +150,10 @@ const plugins = [
region: process.env.S3_REGION,
access_key_id: process.env.S3_ACCESS_KEY_ID,
secret_access_key: process.env.S3_SECRET_ACCESS_KEY,
}
},
},
},
];
]
```
Make sure to define `S3_REGION`, `S3_ACCESS_KEY_ID`, and `S3_SECRET_ACCESS_KEY` in your environment variables first.
@@ -198,14 +198,14 @@ In `next.config.js` add the following option in the exported object:
```jsx title=next.config.js
const { withStoreConfig } = require("./store-config")
//...
// ...
module.exports = withStoreConfig({
//...
// ...
images: {
domains: [
//...
"<BUCKET_NAME>.s3.amazonaws.com"
// ...
"<BUCKET_NAME>.s3.amazonaws.com",
],
},
})