search

IBM / ibm-cos-sdk-js

ibm-cos-sdk-js
Apache License 2.0
38 stars 20 forks source link

Misleading quick start guide in README #75

Closed mriedem closed 3 years ago

mriedem commented 3 years ago

The quick start guide to the IBM Cloud Docs link in the README here:

https://github.com/IBM/ibm-cos-sdk-js#getting-help

Goes here: https://cloud.ibm.com/docs/cloud-object-storage/libraries/node.html#node-js

Which gives instructions about using the IBM COS UI. For someone looking to use this SDK for integrating with their nodejs application, a better link to IBM Cloud docs is probably this one:

https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-node

cloudpitchford commented 3 years ago

Thanks for the pointer! I work with the Cloud Docs so I will follow up on the README change.

UPDATE: Quick investigation shows the redirect for the inactive link points to the "home" or Getting Started… topic in the documentation.

cloudpitchford commented 3 years ago

We have an internal reference and a target date for the change in a release at the end of the month.

IBMeric commented 3 years ago

This issue has been addressed in the 1.8.0 release. Please verify and close the ticket.

mriedem commented 3 years ago

Verified, looks good to me. Thanks!