Skip to content
This repository was archived by the owner on Mar 11, 2022. It is now read-only.

Commit 2d556d8

Browse files
eiriemlaver
andauthored
Update and/or fix IBM Cloud docs links (#452)
* Update/fix IBM Cloud docs links Co-authored-by: Esteban Laver <[email protected]>
1 parent 49ac32a commit 2d556d8

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

README.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -254,8 +254,7 @@ Note, if you only have a single Cloudant service then specifying the
254254

255255
You can optionally provide a callback to the Cloudant initialization
256256
function. This will make the library automatically
257-
[ping](https://cloud.ibm.com/docs/services/Cloudant/api?topic=cloudant-account#ping)
258-
Cloudant to confirm the connection and that your credentials work.
257+
ping Cloudant to confirm the connection and that your credentials work.
259258

260259
Here is a simple example of initializing asynchronously, using its optional
261260
callback parameter:
@@ -284,8 +283,7 @@ Cloudant({ url: url, username: username, password: password }, function(err, clo
284283
initialization callback will always add the `cookieauth` plugin to the list of
285284
configured plugins. If you do not want to use `cookieauth` then you should not
286285
use this initialization callback, instead initalize the client without a
287-
callback and then call the [ping function](https://cloud.ibm.com/docs/services/Cloudant/api?topic=cloudant-account#ping)
288-
e.g.:
286+
callback and then call the ping function e.g.:
289287

290288
```js
291289
const c = new Cloudant({
@@ -469,7 +467,7 @@ var cloudant = Cloudant({ url: myurl, maxAttempt: 5, plugins: [ { iamauth: { iam
469467
(either because the IAM token service is down or the IAM API key is
470468
incorrect) then an error is returned to the client.
471469
472-
See [IBM Cloud Identity and Access Management](https://cloud.ibm.com/docs/services/Cloudant/guides?topic=cloudant-ibm-cloud-identity-and-access-management-iam-) for more information.
470+
See [IBM Cloud Identity and Access Management](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-work-with-your-account#authentication-iam) for more information.
473471
474472
You can turn off automatically refreshing token with the following configuration:
475473
```js
@@ -555,7 +553,7 @@ This library adds documentation for the following:
555553
556554
Cloudant API keys are part of the legacy access controls. They are different from
557555
the access control mechanisms offered by IBM Cloud IAM. See
558-
[here](https://cloud.ibm.com/docs/services/Cloudant/guides?topic=cloudant-ibm-cloud-identity-and-access-management-iam-)
556+
[here](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-work-with-your-account#api-keys)
559557
for more details.
560558
561559
This feature interfaces with the Cloudant [authorization API][Authorization].
@@ -1066,9 +1064,9 @@ await db.partitionedFind('canidae', { 'selector' : { 'name': 'Wolf' }})
10661064
*Create a partitioned search index*
10671065
10681066
To create a [Cloudant
1069-
Search](https://cloud.ibm.com/docs/services/Cloudant?topic=cloudant-search)
1067+
Search](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-search)
10701068
index that is partitioned, write a [design
1071-
document](https://cloud.ibm.com/docs/services/Cloudant?topic=cloudant-design-documents)
1069+
document](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-design-documents)
10721070
to the database containing the index definition. Use `options.partitioned =
10731071
true` to specify that this is a partitioned index:
10741072
@@ -1099,7 +1097,7 @@ await db.insert(ddoc)
10991097
*Search within a partition*
11001098
11011099
To perform a [Cloudant
1102-
Search](https://cloud.ibm.com/docs/services/Cloudant?topic=cloudant-search)
1100+
Search](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-search)
11031101
against a pre-existing Cloudant Search index, use the `partitionedSearch`
11041102
function:
11051103
@@ -1353,13 +1351,13 @@ specific language governing permissions and limitations under the License.
13531351
* [Issues]
13541352
* [Nano Library]
13551353
1356-
[Authentication]: https://cloud.ibm.com/docs/services/Cloudant/api?topic=cloudant-authentication
1357-
[Authorization]: https://cloud.ibm.com/docs/services/Cloudant/api?topic=cloudant-authorization
1358-
[CORS]: https://cloud.ibm.com/docs/services/Cloudant/api?topic=cloudant-cors
1359-
[Cloudant Documentation]: https://cloud.ibm.com/docs/services/Cloudant?topic=cloudant-overview
1360-
[Cloudant Geospatial]: https://cloud.ibm.com/docs/services/Cloudant?topic=cloudant-cloudant-nosql-db-geospatial
1361-
[Cloudant Query]: https://cloud.ibm.com/docs/services/Cloudant?topic=cloudant-query
1362-
[Cloudant Search]: https://cloud.ibm.com/docs/services/Cloudant?topic=cloudant-search
1354+
[Authentication]: https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-faq-authenticating-cloudant
1355+
[Authorization]: https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-managing-access-for-cloudant
1356+
[CORS]: https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-cors
1357+
[Cloudant Documentation]: https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-getting-started-with-cloudant
1358+
[Cloudant Geospatial]: https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-cloudant-nosql-db-geospatial
1359+
[Cloudant Query]: https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-query
1360+
[Cloudant Search]: https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-search
13631361
[Follow library]: https://github.com/cloudant-labs/cloudant-follow
13641362
[Issues]: https://github.com/cloudant/nodejs-cloudant/issues
13651363
[Nano Library]: https://github.com/apache/couchdb-nano

0 commit comments

Comments
 (0)