docs: Improve docs a11y

Signed-off-by: Evangelos Skopelitis <[email protected]>

README.md

@@ -4,16 +4,16 @@
 
 Headlamp is an easy-to-use and extensible Kubernetes web UI.
 
-Headlamp was created to be a Kubernetes web UI that has the traditional functionality of other
-web UIs/dashboards available (i.e. to list and view resources) as well as other features.
+Headlamp was created to blend the traditional feature set of other web UIs/dashboards
+(i.e., to list and view resources) with added functionality.
 
 <div align="center">
   <img src="https://raw.githubusercontent.com/headlamp-k8s/headlamp/screenshots/videos/headlamp_quick_run.gif" width="80%">
 </div>
 
 ## Features
 
-- Vendor independent / generic Kubernetes UI
+- Vendor-independent / generic Kubernetes UI
 - Works in-cluster, or locally as a desktop app
 - Multi-cluster
 - Extensible through plugins
@@ -44,8 +44,8 @@ web UIs/dashboards available (i.e. to list and view resources) as well as other
 
 If you want to deploy Headlamp in your cluster, check out the instructions on running it [in-cluster](https://headlamp.dev/docs/latest/installation/in-cluster/).
 
-If you have a kube config already, you can quickly try Headlamp locally as a
-[desktop application](https://headlamp.dev/docs/latest/installation/desktop/),
+If you have a kubeconfig already, you can quickly try Headlamp locally as a
+[desktop application](https://headlamp.dev/docs/latest/installation/desktop/)
 for [Linux](https://headlamp.dev/docs/latest/installation/desktop/linux-installation),
 [Mac](https://headlamp.dev/docs/latest/installation/desktop/mac-installation),
 or [Windows](https://headlamp.dev/docs/latest/installation/desktop/win-installation).
@@ -55,17 +55,16 @@ in the default path so Headlamp can use it.
 ### Accessing
 
 Headlamp uses [RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac) for checking
-whether and how users can access resources. If you try Headlamp with a token that has very limited
+users' access to resources. If you try Headlamp with a token that has very limited
 permissions, you may not be able to view your cluster resources correctly.
 
 See the documentation on [how to easily get a Service Account token](https://headlamp.dev/docs/latest/installation#create-a-service-account-token) for your cluster.
 
 ## Tested platforms
 
 We maintain a list of the [Kubernetes platforms](./docs/platforms.md) we have
-tested Headlamp with, and invite you to add any missing platform you have
-tested, or comments if there are regressions in already filed platforms that
-should be consider.
+tested Headlamp with. We invite you to add any missing platforms you have
+tested, or comment if there are any regressions in the existing ones.
 
 ## Extensions / Plugins
 
@@ -82,7 +81,7 @@ in the Kubernetes Slack.
 ## Roadmap / Release Planning
 
 If you are interested in the direction of the project, we maintain a
-[Roadmap](https://github.com/orgs/headlamp-k8s/projects/1/views/1) for it, with the
+[Roadmap](https://github.com/orgs/headlamp-k8s/projects/1/views/1). It has the
 biggest changes planned so far, as well as a [board](https://github.com/orgs/headlamp-k8s/projects/1/) tracking each release.
 
 ## License

app/README.md

@@ -24,7 +24,7 @@ Note, it runs the development servers for the backend and the frontend as well.
 - `npm run build`: Copies in all the files and compiles the code. Builds into an unpacked folder in dist/. Useful for testing.
 - `npm run compile-electron`: Compiles the TypeScript code in electron/ folder into JavaScript.
 - `npm run copy-icons`: Copies the icons from the frontend/ folders into build/icons.
-- `npm run copy-plugins`: Is used to bundle plugins in the .plugins folder into the built app.
+- `npm run copy-plugins`: Used to bundle plugins in the .plugins folder into the built app.
 - `npm run dev`: Uses the built code in ../frontend from `npm run build` in that folder.
 - `npm run dev-only-app`: Uses the development front end server.
 - `npm run i18n`: Extract the translations discovered in the electron/ folder source code.

docs/contributing.md

@@ -15,9 +15,9 @@ Please refer to the Kinvolk [Code of Conduct](https://github.com/kinvolk/contrib
 
 ## Development practices
 
-The Headlamp project follows the [Kinvolk Contribution Guidelines](https://github.com/kinvolk/contribution)
+The Headlamp project follows the [Kinvolk Contribution Guidelines](https://github.com/kinvolk/contribution),
 which promotes good and consistent contribution practices across Kinvolk's
-projects. Before start contributing, and in addition to this section, please
+projects. Before starting to contribute, and in addition to this section, please
 read those guidelines.
 
 ## Filing an issue or feature request
@@ -28,7 +28,7 @@ you think are useful.
 ### Security issues
 
 For filing security issues that are sensitive and should not be public, please
-send an email to [email protected] .
+send an email to <[email protected]> .
 
 ## Translations
 
@@ -38,7 +38,7 @@ dedicated [i18n docs](./development/).
 ### Complex contributions
 
 If you have a complex contribution in mind (meaning changes in the architecture
-or a lot of LOC changed), it is advisable to first file a Github issue and
+or a lot of LOC changed), it is advisable to first file a GitHub issue and
 discuss the implementation with the project's maintainers.
 
 ## Coding style
@@ -65,13 +65,13 @@ the CI checks are passing for your PR.
 
 ## Commit guidelines
 
-For the general guidelines on making PRs/commits easier to review, please check
+For general guidelines on making PRs/commits easier to review, please check
 out Kinvolk's
 [contribution guidelines on git](https://github.com/kinvolk/contribution/tree/master/topics/git.md).
 
 ## Testing
 
-The frontend is tested via Storybook related snapshots. So new components should have
+The frontend is tested via Storybook-related snapshots. So new components should have
 an associated story when possible.
 
 For running the frontend tests, use the following command:

docs/development/api/classes/lib_k8s_namespace.Namespace.md

@@ -166,7 +166,7 @@ This function validates the custom namespace input matches the crieria for DNS-1
 
 **`params`** namespace: string
 
-**`see`** https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+**`see`** <https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names>
 
 #### Parameters
 

docs/development/api/classes/plugin_registry.PluginManager.md

@@ -88,7 +88,7 @@ Sends a request to install a plugin from the specified ArtifactHub URL.
 **`static`**
 
 **`example`**
-PluginManager.install('pluginID', ' https://artifacthub.io/packages/headlamp/<repo_name>/<plugin_name>');
+PluginManager.install('pluginID', ' <https://artifacthub.io/packages/headlamp/><repo_name>/<plugin_name>');
 
 #### Parameters
 

docs/development/api/interfaces/lib_k8s_apiProxy.QueryParameters.md

@@ -22,7 +22,7 @@ allowWatchBookmarks means watch events with type "BOOKMARK" will also be sent.
 
 Can be 'true'
 
-**`see`** https://kubernetes.io/docs/reference/using-api/api-concepts/#watch-bookmarks
+**`see`** <https://kubernetes.io/docs/reference/using-api/api-concepts/#watch-bookmarks>
 
 #### Defined in
 
@@ -55,7 +55,7 @@ the "next key".
 This field is not supported when watch is true. Clients may start a watch from
 the last resourceVersion value returned by the server and not miss any modifications.
 
-**`see`** https://kubernetes.io/docs/reference/using-api/api-concepts/#retrieving-large-results-sets-in-chunks
+**`see`** <https://kubernetes.io/docs/reference/using-api/api-concepts/#retrieving-large-results-sets-in-chunks>
 
 #### Defined in
 
@@ -70,7 +70,7 @@ ___
 dryRun causes apiserver to simulate the request, and report whether the object would be modified.
 Can be '' or 'All'
 
-**`see`** https://kubernetes.io/docs/reference/using-api/api-concepts/#dry-run
+**`see`** <https://kubernetes.io/docs/reference/using-api/api-concepts/#dry-run>
 
 #### Defined in
 
@@ -84,7 +84,7 @@ ___
 
 fieldSeletor restricts the list of returned objects by their fields. Defaults to everything.
 
-**`see`** https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/
+**`see`** <https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/>
 
 #### Defined in
 
@@ -98,9 +98,9 @@ ___
 
 labelSelector restricts the list of returned objects by their labels. Defaults to everything.
 
-**`see`** https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api
+**`see`** <https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api>
 
-**`see`** https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
+**`see`** <https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors>
 
 #### Defined in
 
@@ -126,7 +126,7 @@ that no more results are available.
 
 This field is not supported if watch is true.
 
-**`see`** https://kubernetes.io/docs/reference/using-api/api-concepts/#retrieving-large-results-sets-in-chunks
+**`see`** <https://kubernetes.io/docs/reference/using-api/api-concepts/#retrieving-large-results-sets-in-chunks>
 
 #### Defined in
 
@@ -141,7 +141,7 @@ ___
 If 'true', then the output is pretty printed.
 Can be '' or 'true'
 
-**`see`** https://kubernetes.io/docs/reference/using-api/api-concepts/#output-options
+**`see`** <https://kubernetes.io/docs/reference/using-api/api-concepts/#output-options>
 
 #### Defined in
 
@@ -156,9 +156,9 @@ ___
 resourceVersion sets a constraint on what resource versions a request may be served from.
 Defaults to unset
 
-**`see`** https://kubernetes.io/docs/reference/using-api/api-concepts/#efficient-detection-of-changes
+**`see`** <https://kubernetes.io/docs/reference/using-api/api-concepts/#efficient-detection-of-changes>
 
-**`see`** https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions
+**`see`** <https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions>
 
 #### Defined in
 
@@ -172,7 +172,7 @@ ___
 
 The resource version to match.
 
-**`see`** https://kubernetes.io/docs/reference/using-api/api-concepts/#semantics-for-get-and-list
+**`see`** <https://kubernetes.io/docs/reference/using-api/api-concepts/#semantics-for-get-and-list>
 
 #### Defined in
 
@@ -189,7 +189,7 @@ for a watch before sending the current list state.
 
 Can be 'true'.
 
-**`see`** https://kubernetes.io/docs/reference/using-api/api-concepts/#streaming-lists
+**`see`** <https://kubernetes.io/docs/reference/using-api/api-concepts/#streaming-lists>
 
 #### Defined in
 
@@ -205,7 +205,7 @@ watch instead of a list or get, watch for changes to the requested object(s).
 
 Can be 1.
 
-**`see`** https://kubernetes.io/docs/reference/using-api/api-concepts/#efficient-detection-of-changes
+**`see`** <https://kubernetes.io/docs/reference/using-api/api-concepts/#efficient-detection-of-changes>
 
 #### Defined in
 

docs/development/api/interfaces/lib_k8s_cluster.ApiListOptions.md

@@ -20,7 +20,7 @@ allowWatchBookmarks means watch events with type "BOOKMARK" will also be sent.
 
 Can be 'true'
 
-**`see`** https://kubernetes.io/docs/reference/using-api/api-concepts/#watch-bookmarks
+**`see`** <https://kubernetes.io/docs/reference/using-api/api-concepts/#watch-bookmarks>
 
 #### Inherited from
 
@@ -69,7 +69,7 @@ the "next key".
 This field is not supported when watch is true. Clients may start a watch from
 the last resourceVersion value returned by the server and not miss any modifications.
 
-**`see`** https://kubernetes.io/docs/reference/using-api/api-concepts/#retrieving-large-results-sets-in-chunks
+**`see`** <https://kubernetes.io/docs/reference/using-api/api-concepts/#retrieving-large-results-sets-in-chunks>
 
 #### Inherited from
 
@@ -88,7 +88,7 @@ ___
 dryRun causes apiserver to simulate the request, and report whether the object would be modified.
 Can be '' or 'All'
 
-**`see`** https://kubernetes.io/docs/reference/using-api/api-concepts/#dry-run
+**`see`** <https://kubernetes.io/docs/reference/using-api/api-concepts/#dry-run>
 
 #### Inherited from
 
@@ -106,7 +106,7 @@ ___
 
 fieldSeletor restricts the list of returned objects by their fields. Defaults to everything.
 
-**`see`** https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/
+**`see`** <https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/>
 
 #### Inherited from
 
@@ -124,9 +124,9 @@ ___
 
 labelSelector restricts the list of returned objects by their labels. Defaults to everything.
 
-**`see`** https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api
+**`see`** <https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api>
 
-**`see`** https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
+**`see`** <https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors>
 
 #### Inherited from
 
@@ -156,7 +156,7 @@ that no more results are available.
 
 This field is not supported if watch is true.
 
-**`see`** https://kubernetes.io/docs/reference/using-api/api-concepts/#retrieving-large-results-sets-in-chunks
+**`see`** <https://kubernetes.io/docs/reference/using-api/api-concepts/#retrieving-large-results-sets-in-chunks>
 
 #### Inherited from
 
@@ -187,7 +187,7 @@ ___
 If 'true', then the output is pretty printed.
 Can be '' or 'true'
 
-**`see`** https://kubernetes.io/docs/reference/using-api/api-concepts/#output-options
+**`see`** <https://kubernetes.io/docs/reference/using-api/api-concepts/#output-options>
 
 #### Inherited from
 
@@ -206,9 +206,9 @@ ___
 resourceVersion sets a constraint on what resource versions a request may be served from.
 Defaults to unset
 
-**`see`** https://kubernetes.io/docs/reference/using-api/api-concepts/#efficient-detection-of-changes
+**`see`** <https://kubernetes.io/docs/reference/using-api/api-concepts/#efficient-detection-of-changes>
 
-**`see`** https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions
+**`see`** <https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions>
 
 #### Inherited from
 
@@ -226,7 +226,7 @@ ___
 
 The resource version to match.
 
-**`see`** https://kubernetes.io/docs/reference/using-api/api-concepts/#semantics-for-get-and-list
+**`see`** <https://kubernetes.io/docs/reference/using-api/api-concepts/#semantics-for-get-and-list>
 
 #### Inherited from
 
@@ -247,7 +247,7 @@ for a watch before sending the current list state.
 
 Can be 'true'.
 
-**`see`** https://kubernetes.io/docs/reference/using-api/api-concepts/#streaming-lists
+**`see`** <https://kubernetes.io/docs/reference/using-api/api-concepts/#streaming-lists>
 
 #### Inherited from
 
@@ -267,7 +267,7 @@ watch instead of a list or get, watch for changes to the requested object(s).
 
 Can be 1.
 
-**`see`** https://kubernetes.io/docs/reference/using-api/api-concepts/#efficient-detection-of-changes
+**`see`** <https://kubernetes.io/docs/reference/using-api/api-concepts/#efficient-detection-of-changes>
 
 #### Inherited from
 

docs/development/api/interfaces/lib_k8s_cluster.KubeContainer.md

@@ -4,7 +4,7 @@
 
 [lib/k8s/cluster](../modules/lib_k8s_cluster.md).KubeContainer
 
-**`link`** https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#container-v1-core
+**`link`** <https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#container-v1-core>
 
 ## Properties
 
@@ -137,11 +137,11 @@ ___
 List of ports to expose from the container. Not specifying a port here DOES NOT prevent that
 port from being exposed. Any port which is listening on the default "0.0.0.0" address inside
 a container will be accessible from the network. Modifying this array with strategic merge
-patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.
+patch may corrupt the data. For more information See <https://github.com/kubernetes/kubernetes/issues/108255>.
 
 Cannot be updated.
 
-https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#containerport-v1-core
+<https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#containerport-v1-core>
 
 #### Defined in
 
@@ -186,7 +186,7 @@ Compute Resources required by this container. Cannot be updated.
 
 **`see`** [more info](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/)
 
-https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#resourcerequirements-v1-core
+<https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#resourcerequirements-v1-core>
 
 #### Type declaration
 

docs/development/api/interfaces/lib_k8s_cluster.KubeMetadata.md

@@ -138,7 +138,7 @@ ___
 
 A map of string keys and values that can be used to organize and categorize objects
 
-**`see`** https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
+**`see`** <https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/>
 
 #### Defined in
 

docs/development/api/interfaces/lib_k8s_kubeconfig.KubeconfigObject.md

@@ -9,6 +9,7 @@ It is a JSON encoded version of the kubeconfig file.
 It is used to store the kubeconfig for stateless clusters.
 This is basically a k8s client - go Kubeconfig object.
 KubeconfigObject holds the information needed to build connect to remote kubernetes clusters as a given user
+
 * @see [more info](https://kubernetes.io/docs/reference/config-api/kubeconfig.v1/)
 
 **`see`** storeStatelessClusterKubeconfig