Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Misleading quick start guide in README #75

Closed
mriedem opened this issue Sep 18, 2020 · 4 comments
Closed

Misleading quick start guide in README #75

mriedem opened this issue Sep 18, 2020 · 4 comments

Comments

@mriedem
Copy link
Member

mriedem commented Sep 18, 2020

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
Copy link
Contributor

cloudpitchford commented Sep 21, 2020

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
Copy link
Contributor

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

@IBMeric
Copy link
Member

IBMeric commented Oct 28, 2020

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

@mriedem
Copy link
Member Author

mriedem commented Oct 28, 2020

Verified, looks good to me. Thanks!

@mriedem mriedem closed this as completed Oct 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants