Skip to content

Commit 0d783e1

Browse files
author
Palumbo
committed
docs(contributing): updating the links in the documentation
1 parent 0d20ce7 commit 0d783e1

File tree

5 files changed

+12
-65
lines changed

5 files changed

+12
-65
lines changed

docs/cli/csv-parser-price.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Errors on the level `error` come from events that are fatal and thus stop the st
7979

8080
`CsvParserPrice` accepts three objects as arguments:
8181

82-
- API client credentials for the [authentication middleware](https://commercetools.github.io/nodejs/docs/sdk/api/createAuthMiddlewareForClientCredentialsFlow.html) (_required_)
82+
- API client credentials for the [authentication middleware](https://commercetools.github.io/nodejs/sdk/api/sdkAuth.html) (_required_)
8383
- Logger takes object with four functions (_optional_)
8484
- Config (_optional_)
8585
- `batchSize`: number of CSV rows to handle simultaneously. (_default_: `100`)

docs/cli/resource-deleter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ A package which deletes resources from the [commercetools platform](https://docs
44

55
Examples of the resources are :
66

7-
- [carts](https://docs.commercetools.com/api/projects/carts#delete-a-cart)
7+
- [carts](https://docs.commercetools.com/api/projects/carts#delete-cart)
88
- [categories](https://docs.commercetools.com/api/projects/categories#delete-category)
99
- [channels](https://docs.commercetools.com/api/projects/channels#delete-channel)
1010
- [customergroups](https://docs.commercetools.com/api/projects/customerGroups#delete-customergroup)

docs/sdk/Glossary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Glossary
22

3-
This is a glossary of the core terms around SDK packages, along with their type signatures. The types are documented using [Flow notation](https://flowtype.org/docs/quick-reference.html).
3+
This is a glossary of the core terms around SDK packages, along with their type signatures. The types are documented using [Flow notation](https://flow.org/en/docs/types/).
44

55
## ClientRequest
66

docs/sdk/api/typescriptSdk.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@ See full usage example [here](https://github.com/commercetools/commercetools-sdk
5050
```bash
5151
npm install --save @commercetools/platform-sdk
5252
npm install --save @commercetools/importapi-sdk
53-
npm install --save @commercetools/ml-sdk
5453
npm install --save @commercetools/sdk-client-v2
5554
```
5655
@@ -525,7 +524,7 @@ const client: Client = new ClientBuilder()
525524
526525
### 2. Other middleware creator methods
527526
528-
There are also other class methods that creates middlewares used to fully cusotmize and control the client, they are described in details below.
527+
However, there are other class methods that creates middlewares used to fully customize and control the client, they are described in details below.
529528
530529
#### withHttpMiddleware(options: _HttpMiddlewareOptions_)
531530
@@ -552,13 +551,13 @@ The HTTP middleware can run in either a browser or Node.js environment. For Node
552551
553552
#### Note:
554553
555-
The `arbortController` property is deprecated, use the `getAbortController` property instead.
554+
The `abortController` property is deprecated, use the `getAbortController` property instead.
556555
557556
#### Retrying requests
558557
559-
This modules have a retrying ability incase of network failures or 503 response errors. To enable this behavior, pass the `enableRetry` flag in the options and also set the maximum number of retries (`maxRetries`) and amount in milliseconds to wait before retrying a request (`retryDelay`).
558+
This modules have a retrying ability in case of network failures or 503 response errors. To enable this behavior, pass the `enableRetry` flag in the options and also set the maximum number of retries (`maxRetries`) and amount in milliseconds to wait before retrying a request (`retryDelay`).
560559
561-
The repeater implements an `exponential` delay, meaning the wait time is not constant and it grows on every retry.
560+
The repeater implements an `exponential` delay, meaning the wait time is not constant, and it grows on every retry.
562561
563562
#### retryConfig
564563

yarn.lock

Lines changed: 5 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1318,23 +1318,6 @@
13181318
resolved "https://registry.yarnpkg.com/@commercetools/sdk-middleware-logger/-/sdk-middleware-logger-2.1.2.tgz#6b8ce77699bf5d8e5ec4f243a2c9d691094ef0c7"
13191319
integrity sha512-uGhhAUnZzLWO3ozzz6VDMUAKr5Y9ctVyqfExXVC7t37IgppLsKrrvLl6VMoU2uXjIGSNA0VN0Kxgj93rBBejTQ==
13201320

1321-
"@commercetools/sync-actions@^5.0.0":
1322-
version "5.19.2"
1323-
resolved "https://registry.yarnpkg.com/@commercetools/sync-actions/-/sync-actions-5.19.2.tgz#93cf5bd624feeabe56517299b3c54b13593eb906"
1324-
integrity sha512-9CrqaSxhZ2+TIcfr1Jvatj1Mme85rYkWtcAevrA/wqYbTkU095hQMHu1cIJ3vH4zkKXtq6ORL0k1DXVLgy8lXA==
1325-
dependencies:
1326-
fast-equals "^2.0.0"
1327-
jsondiffpatch "^0.4.0"
1328-
lodash.flatten "^4.4.0"
1329-
lodash.foreach "^4.5.0"
1330-
lodash.intersection "^4.4.0"
1331-
lodash.isequal "^4.5.0"
1332-
lodash.isnil "^4.0.0"
1333-
lodash.shuffle "^4.2.0"
1334-
lodash.sortby "^4.7.0"
1335-
lodash.uniqwith "^4.5.0"
1336-
lodash.without "^4.4.0"
1337-
13381321
"@commitlint/[email protected]":
13391322
version "19.7.1"
13401323
resolved "https://registry.yarnpkg.com/@commitlint/cli/-/cli-19.7.1.tgz#aca351ae6200af58b49de58181319015e7429601"
@@ -4553,7 +4536,7 @@ chainsaw@~0.1.0:
45534536
dependencies:
45544537
traverse ">=0.3.0 <0.4"
45554538

4556-
[email protected], [email protected], chalk@^1.1.3, chalk@^2.0.1, chalk@^2.3.0, chalk@^2.4.1, chalk@^2.4.2, chalk@^3.0.0, chalk@^4.0.0, chalk@^4.1.0, chalk@^4.1.1, chalk@^5.3.0:
4539+
[email protected], [email protected], chalk@^1.1.3, chalk@^2.0.1, chalk@^2.4.1, chalk@^2.4.2, chalk@^3.0.0, chalk@^4.0.0, chalk@^4.1.0, chalk@^4.1.1, chalk@^5.3.0:
45574540
version "3.0.0"
45584541
resolved "https://registry.yarnpkg.com/chalk/-/chalk-3.0.0.tgz#3f73c2bf526591f574cc492c51e2456349f844e4"
45594542
integrity sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==
@@ -5557,7 +5540,7 @@ debug@^3.0.1, debug@^3.1.0, debug@^3.2.7:
55575540
dependencies:
55585541
ms "^2.1.1"
55595542

5560-
debuglog@*, debuglog@^1.0.1:
5543+
debuglog@^1.0.1:
55615544
version "1.0.1"
55625545
resolved "https://registry.yarnpkg.com/debuglog/-/debuglog-1.0.1.tgz#aa24ffb9ac3df9a2351837cfb2d279360cd78492"
55635546
integrity sha512-syBZ+rnAK3EgMsH2aYEOLUW7mZSY9Gb+0wUMCFsZvcmiz+HigA0LOcq/HoQqVuGG+EKykunc7QG2bzrponfaSw==
@@ -5707,7 +5690,7 @@ dezalgo@^1.0.0, dezalgo@~1.0.3:
57075690
asap "^2.0.0"
57085691
wrappy "1"
57095692

5710-
diff-match-patch@^1.0.0, diff-match-patch@^1.0.5:
5693+
diff-match-patch@^1.0.5:
57115694
version "1.0.5"
57125695
resolved "https://registry.yarnpkg.com/diff-match-patch/-/diff-match-patch-1.0.5.tgz#abb584d5f10cd1196dfc55aa03701592ae3f7b37"
57135696
integrity sha512-IayShXAgj/QMXgB0IWmKx+rOPuGMhqm5w6jvFxmVenXKIzRqTAAsbBPT3kWQeGANj3jGgvcvv4yK6SxqYmikgw==
@@ -7922,7 +7905,7 @@ import-meta-resolve@^4.0.0:
79227905
resolved "https://registry.yarnpkg.com/import-meta-resolve/-/import-meta-resolve-4.1.0.tgz#f9db8bead9fafa61adb811db77a2bf22c5399706"
79237906
integrity sha512-I6fiaX09Xivtk+THaMfAwnA3MVA5Big1WHF1Dfx9hFuvNIWpXnorlkzhcQf6ehrqQiiZECRt1poOAkPmer3ruw==
79247907

7925-
imurmurhash@*, imurmurhash@^0.1.4:
7908+
imurmurhash@^0.1.4:
79267909
version "0.1.4"
79277910
resolved "https://registry.yarnpkg.com/imurmurhash/-/imurmurhash-0.1.4.tgz#9218b9b2b928a238b13dc4fb6b6d576f231453ea"
79287911
integrity sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==
@@ -9302,14 +9285,6 @@ [email protected]:
93029285
chalk "^5.3.0"
93039286
diff-match-patch "^1.0.5"
93049287

9305-
jsondiffpatch@^0.4.0:
9306-
version "0.4.1"
9307-
resolved "https://registry.yarnpkg.com/jsondiffpatch/-/jsondiffpatch-0.4.1.tgz#9fb085036767f03534ebd46dcd841df6070c5773"
9308-
integrity sha512-t0etAxTUk1w5MYdNOkZBZ8rvYYN5iL+2dHCCx/DpkFm/bW28M6y5nUS83D4XdZiHy35Fpaw6LBb+F88fHZnVCw==
9309-
dependencies:
9310-
chalk "^2.3.0"
9311-
diff-match-patch "^1.0.0"
9312-
93139288
jsonfile@^4.0.0:
93149289
version "4.0.0"
93159290
resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-4.0.0.tgz#8771aae0799b64076b76640fca058f9c10e33ecb"
@@ -9796,11 +9771,6 @@ lodash._basecreate@^3.0.0:
97969771
resolved "https://registry.yarnpkg.com/lodash._basecreate/-/lodash._basecreate-3.0.3.tgz#1bc661614daa7fc311b7d03bf16806a0213cf821"
97979772
integrity sha512-EDem6C9iQpn7fxnGdmhXmqYGjCkStmDXT4AeyB2Ph8WKbglg4aJZczNkQglj+zWXcOEEkViK8THuV2JvugW47g==
97989773

9799-
lodash._baseindexof@*:
9800-
version "3.1.0"
9801-
resolved "https://registry.yarnpkg.com/lodash._baseindexof/-/lodash._baseindexof-3.1.0.tgz#fe52b53a1c6761e42618d654e4a25789ed61822c"
9802-
integrity sha512-bSYo8Pc/f0qAkr8fPJydpJjtrHiSynYfYBjtANIgXv5xEf1WlTC63dIDlgu0s9dmTvzRu1+JJTxcIAHe+sH0FQ==
9803-
98049774
lodash._baseuniq@~4.6.0:
98059775
version "4.6.0"
98069776
resolved "https://registry.yarnpkg.com/lodash._baseuniq/-/lodash._baseuniq-4.6.0.tgz#0ebb44e456814af7905c6212fa2c9b2d51b841e8"
@@ -9809,29 +9779,12 @@ lodash._baseuniq@~4.6.0:
98099779
lodash._createset "~4.0.0"
98109780
lodash._root "~3.0.0"
98119781

9812-
lodash._bindcallback@*:
9813-
version "3.0.1"
9814-
resolved "https://registry.yarnpkg.com/lodash._bindcallback/-/lodash._bindcallback-3.0.1.tgz#e531c27644cf8b57a99e17ed95b35c748789392e"
9815-
integrity sha512-2wlI0JRAGX8WEf4Gm1p/mv/SZ+jLijpj0jyaE/AXeuQphzCgD8ZQW4oSpoN8JAopujOFGU3KMuq7qfHBWlGpjQ==
9816-
9817-
lodash._cacheindexof@*:
9818-
version "3.0.2"
9819-
resolved "https://registry.yarnpkg.com/lodash._cacheindexof/-/lodash._cacheindexof-3.0.2.tgz#3dc69ac82498d2ee5e3ce56091bafd2adc7bde92"
9820-
integrity sha512-S8dUjWr7SUT/X6TBIQ/OYoCHo1Stu1ZRy6uMUSKqzFnZp5G5RyQizSm6kvxD2Ewyy6AVfMg4AToeZzKfF99T5w==
9821-
9822-
lodash._createcache@*:
9823-
version "3.1.2"
9824-
resolved "https://registry.yarnpkg.com/lodash._createcache/-/lodash._createcache-3.1.2.tgz#56d6a064017625e79ebca6b8018e17440bdcf093"
9825-
integrity sha512-ev5SP+iFpZOugyab/DEUQxUeZP5qyciVTlgQ1f4Vlw7VUcCD8fVnyIqVUEIaoFH9zjAqdgi69KiofzvVmda/ZQ==
9826-
dependencies:
9827-
lodash._getnative "^3.0.0"
9828-
98299782
lodash._createset@~4.0.0:
98309783
version "4.0.3"
98319784
resolved "https://registry.yarnpkg.com/lodash._createset/-/lodash._createset-4.0.3.tgz#0f4659fbb09d75194fa9e2b88a6644d363c9fe26"
98329785
integrity sha512-GTkC6YMprrJZCYU3zcqZj+jkXkrXzq3IPBcF/fIPpNEAB4hZEtXU8zp/RwKOvZl43NUmwDbyRk3+ZTbeRdEBXA==
98339786

9834-
lodash._getnative@*, lodash._getnative@^3.0.0:
9787+
lodash._getnative@^3.0.0:
98359788
version "3.9.1"
98369789
resolved "https://registry.yarnpkg.com/lodash._getnative/-/lodash._getnative-3.9.1.tgz#570bc7dede46d61cdcde687d65d3eecbaa3aaff5"
98379790
integrity sha512-RrL9VxMEPyDMHOd9uFbvMe8X55X16/cGM5IgOKgRElQZutpX89iS6vwl64duTV1/16w5JY7tuFNXqoekmh1EmA==
@@ -10039,11 +9992,6 @@ lodash.reject@^4.4.0:
100399992
resolved "https://registry.yarnpkg.com/lodash.reject/-/lodash.reject-4.6.0.tgz#80d6492dc1470864bbf583533b651f42a9f52415"
100409993
integrity sha512-qkTuvgEzYdyhiJBx42YPzPo71R1aEr0z79kAv7Ixg8wPFEjgRgJdUsGMG3Hf3OYSF/kHI79XhNlt+5Ar6OzwxQ==
100419994

10042-
lodash.restparam@*:
10043-
version "3.6.1"
10044-
resolved "https://registry.yarnpkg.com/lodash.restparam/-/lodash.restparam-3.6.1.tgz#936a4e309ef330a7645ed4145986c85ae5b20805"
10045-
integrity sha512-L4/arjjuq4noiUJpt3yS6KIKDtJwNe2fIYgMqyYYKoeIfV1iEqvPwhCx23o+R9dzouGihDAPN1dTIRWa7zk8tw==
10046-
100479995
lodash.shuffle@^4.2.0:
100489996
version "4.2.0"
100499997
resolved "https://registry.yarnpkg.com/lodash.shuffle/-/lodash.shuffle-4.2.0.tgz#145b5053cf875f6f5c2a33f48b6e9948c6ec7b4b"

0 commit comments

Comments
 (0)