apache / apache/openwhisk-package-cloudant

in-code docs have hrefs to non-existant pages

Open
#175 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Scala
Stars
17
Forks
31
PR merge metrics
No merged PRs in 30d

Description

e.g. https://github.com/apache/incubator-openwhisk-package-cloudant/blob/master/actions/account-actions/read-database.js

which has a link https://docs.cloudant.com/database.html#read

which now resolves to https://console.bluemix.net/docs/services/Cloudant/getting-started.html#read, which does not document read-database.

for this one, maybe the updated link should be https://console.bluemix.net/docs/services/Cloudant/api/database.html#getting-database-details

but a more thorough auditing is necessary

Contributor guide

Open the contributing guide

Research direction

Start with actions/account-actions/read-database.js and inspect its Cloudant documentation hrefs, including the database read link cited in the issue. Compare each destination with the current Cloudant documentation and identify non-existent or outdated pages. Done means the in-code links have been audited and updated to valid, relevant destinations.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.