apache / apache/openwhisk-website

Use descriptive link texts (instead of "here" or "click here")

Open
#305 0 comments 0 reactions 0 assignees View on GitHub
documentation priority: low
Dominant language
HTML
Stars
21
Forks
48
PR merge metrics
No merged PRs in 30d

Description

Using "here" or "click here" is bad practice when it comes to SEO and Accessibility, we should replace those with something more descriptive. See the articles below for more information on the subject.

### Articles explaining the difference between descriptive links and "click here" links
https://webaccess.berkeley.edu/ask-pecan/click-here
http://dotmonster.co/blog/why-using-click-here-for-links-is-bad-practice

### Examples of where we are going against the best practice

> You can read about the list of OpenWhisk components and its internal flow of processing here.

> Here are the instructions and details on how to deploy OpenWhisk on OpenShift.

> Download the wsk CLI: Download wsk binary for your local environment into a location in your shell path from here.

> Note: Before you proceed with the deployment, please make sure you have the authentication setup as described here.

> Here is the list of runtimes supported by OpenWhisk:

> The OpenWhisk platform is extensible and you can add new languages or runtimes (with custom packages and third-party dependencies) following the guide described here.

> OpenWhisk comes with a list of packages You can get more details on OpenWhisk packages here.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.