Broken links docs fix (#2134)

* Update links in docs Some relative links were wrongly pointing to nowhere * Update links in docs Some relative links were wrongly pointing to nowhere * Update links in docs Some relative links were wrongly pointing to nowhere * Update links in docs Some relative links were wrongly pointing to nowhere * Update links in docs Some relative links were wrongly pointing to nowhere * Update links in docs Some relative links were wrongly pointing to nowhere * Update links in docs Some relative links were wrongly pointing to nowhere. In this case, pusher/oauth2_proxy but has been renamed as of 29/03/2020 to oauth2-proxy/oauth2-proxy, so the references here have been changed accordingly. * Update links in docs Some relative links were wrongly pointing to nowhere. The Harbor repo has moved their docs; consequently, references here have been changed accordingly. * Update links in docs Some relative links were wrongly pointing to nowhere. Here, a k8s link was also broken * Update links in docs Some relative links were wrongly pointing to nowhere. Here, a k8s link was also broken * Update links in docs A k8s link was broken. Minikube also misspelled * Update links in docs Removed service-catalog.md link * Update README.md Update the current index of proposals * Update links in docs Some relative links were wrongly pointing to nowhere. Here, a Helm link was also broken * Change relative links to absolute ones in chart readme Since this file is being rendered outside github.com it should not contain any relative links. Minor typos fix. * Fix minor typos * Change wrong relative link usage Since docs/user is being rendered in other places rather than github.com, links pointing outside /docs must be absolutes * Change /tree to /blob in docs links To avoid an unnecessary redirection, /tree links should only point to 'directories' not specific files.
vmware-tanzu · Nov 4, 2020 · 1c3d387 · 1c3d387
1 parent bd85fbb
commit 1c3d387
Show file tree

Hide file tree

Showing 20 changed files with 75 additions and 67 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -15,7 +15,7 @@ Please note we have a code of conduct, please follow it in all your interactions
 
 All authors to the project retain copyright to their work. However, to ensure
 that they are only submitting work that they have rights to, we are requiring
-everyone to acknowldge this by signing their work.
+everyone to acknowledge this by signing their work.
 
 Any copyright notices in this repo should specify the authors as "the contributors".
 

diff --git a/README.md b/README.md
@@ -8,8 +8,8 @@ Kubeapps is a web-based UI for deploying and managing applications in Kubernetes
 - Inspect, upgrade and delete Helm-based applications installed in the cluster
 - Add custom and private chart repositories (supports [ChartMuseum](https://github.com/helm/chartmuseum) and [JFrog Artifactory](https://www.jfrog.com/confluence/display/RTF/Helm+Chart+Repositories))
 - Browse and deploy [Kubernetes Operators](https://operatorhub.io/).
-- Secure authentication to Kubeapps using an [OAuth2/OIDC provider](https://github.com/kubeapps/kubeapps/blob/master/docs/user/using-an-OIDC-provider.md)
-- Secure authorization based on Kubernetes [Role-Based Access Control](https://github.com/kubeapps/kubeapps/blob/master/docs/user/access-control.md)
+- Secure authentication to Kubeapps using an [OAuth2/OIDC provider](./docs/user/using-an-OIDC-provider.md)
+- Secure authorization based on Kubernetes [Role-Based Access Control](./docs/user/access-control.md)
 
 ## Quick Start
 
@@ -21,25 +21,25 @@ kubectl create namespace kubeapps
 helm install kubeapps --namespace kubeapps bitnami/kubeapps
 ``` 
 
-***Note:*** Kubeapps 2.0 and onwards supports Helm 3 only. While only the Helm 3 API is supported, in most cases, charts made for Helm 2 will still work. For detailed instructions on how to install and use Kubeapps follow the [Getting Started Guide](docs/user/getting-started.md).
+***Note:*** Kubeapps 2.0 and onwards supports Helm 3 only. While only the Helm 3 API is supported, in most cases, charts made for Helm 2 will still work. For detailed instructions on how to install and use Kubeapps follow the [Getting Started Guide](./docs/user/getting-started.md).
 
 ## Developer Documentation
 
 Please refer to:
 
-- The [Kubeapps Build Guide](docs/developer/build.md) for instructions on setting up the build environment and building Kubeapps from source.
-- The [Kubeapps Developer Documentation](docs/developer/README.md) for instructions on setting up the developer environment for developing on Kubeapps and its components.
+- The [Kubeapps Build Guide](./docs/developer/build.md) for instructions on setting up the build environment and building Kubeapps from source.
+- The [Kubeapps Developer Documentation](./docs/developer/README.md) for instructions on setting up the developer environment for developing on Kubeapps and its components.
 
 ## Next Steps
 
-If you have followed the instructions for [installing Kubeapps](docs/user/getting-started.md) check how to [use Kubeapps](docs/user/dashboard.md) to easily manage your applications running in your cluster, or [look under the hood to see what's included in Kubeapps](docs/architecture/overview.md).
+If you have followed the instructions for [installing Kubeapps](./docs/user/getting-started.md) check how to [use Kubeapps](./docs/user/dashboard.md) to easily manage your applications running in your cluster, or [look under the hood to see what's included in Kubeapps](./docs/architecture/overview.md).
 
 ## Useful Resources
 
-- [Walkthrough for first-time users](docs/user/getting-started.md)
+- [Walkthrough for first-time users](./docs/user/getting-started.md)
 - [Detailed installation instructions](chart/kubeapps/README.md)
-- [Kubeapps Dashboard documentation](docs/user/dashboard.md)
-- [Kubeapps components](docs/architecture/overview.md)
+- [Kubeapps Dashboard documentation](./docs/user/dashboard.md)
+- [Kubeapps components](./docs/architecture/overview.md)
 - [Roadmap](https://github.com/kubeapps/kubeapps/wiki/Roadmap)
 
 ## Differences from Monocular

diff --git a/chart/kubeapps/README.md b/chart/kubeapps/README.md
@@ -103,7 +103,7 @@ Most likely you will only want to have one hostname that maps to this Kubeapps i
 
 ##### Annotations
 
-For annotations, please see [this document](https://github.com/kubernetes/ingress-nginx/blob/master/docs/user-guide/nginx-configuration/annotations.md). Not all annotations are supported by all ingress controllers, but this document does a good job of indicating which annotation is supported by many popular ingress controllers. Annotations can be set using `ingress.annotations`.
+For annotations, please see [this document](https://github.com/kubeapps/kubeapps/blob/master/docs/user-guide/nginx-configuration/annotations.md). Not all annotations are supported by all ingress controllers, but this document does a good job of indicating which annotation is supported by many popular ingress controllers. Annotations can be set using `ingress.annotations`.
 
 ##### TLS
 
@@ -147,7 +147,7 @@ The first command removes most of the Kubernetes components associated with the
 
 > **NOTE**: If you delete the CRD for `apprepositories.kubeapps.com` it will delete the repositories for **all** the installed instances of `kubeapps`. This will break existing installations of `kubeapps` if they exist.
 
-If you have dedicated a namespace only for Kubeapps you can completely clean remaining completed/failed jobs or any stale resources by deleting the namespace
+If you have dedicated a namespace only for Kubeapps you can completely clean the remaining completed/failed jobs or any stale resources by deleting the namespace
 
 ```bash
 kubectl delete namespace kubeapps
@@ -179,7 +179,7 @@ Or:
 Error: namespaces "kubeapps" is forbidden: User "system:serviceaccount:kube-system:default" cannot get namespaces in the namespace "kubeapps"
 ```
 
-It is possible, though uncommon, that your cluster does not have Role Based Access Control (RBAC) enabled. To check if your cluster has RBAC you can execute:
+It is possible, though uncommon, that your cluster does not have Role-Based Access Control (RBAC) enabled. To check if your cluster has RBAC you can execute:
 
 ```bash
 kubectl api-versions
@@ -195,7 +195,7 @@ helm install --name kubeapps --namespace kubeapps bitnami/kubeapps --set rbac.cr
 
 It is possible that when upgrading Kubeapps an error appears. That can be caused by a breaking change in the new chart or because the current chart installation is in an inconsistent state. If you find issues upgrading Kubeapps you can follow these steps:
 
-> Note: This steps assume that you have installed Kubeapps in the namespace `kubeapps` using the name `kubeapps`. If that is not the case replace the command with your namespace and/or name.
+> Note: These steps assume that you have installed Kubeapps in the namespace `kubeapps` using the name `kubeapps`. If that is not the case replace the command with your namespace and/or name.
 
 > Note: If you are upgrading from 1.X to 2.X see the [following section](#upgrading-to-2-0).
 
@@ -247,8 +247,8 @@ After that you should be able to access the new version of Kubeapps. If the abov
 Kubeapps 2.0 (Chart version 4.0.0) introduces some breaking changes:
 
  - Helm 2 is no longer supported. If you are still using some Helm 2 charts, [migrate them with the available tools](https://helm.sh/docs/topics/v2_v3_migration/). Note that some charts (but not all of them) may require to be migrated to the [new Chart specification (v2)](https://helm.sh/docs/topics/charts/#the-apiversion-field). If you are facing any issue managing this migration and Kubeapps, please open a new issue!
- - MongoDB is not longer supported. Since 2.0, the only database supported is PostgreSQL.
- - PosgreSQL chart dependency has been upgraded to a new major version.
+ - MongoDB is no longer supported. Since 2.0, the only database supported is PostgreSQL.
+ - PostgreSQL chart dependency has been upgraded to a new major version.
 
 Due to the last point, it's necessary to run a command before upgrading to Kubeapps 2.0:
 

diff --git a/docs/architecture/design-proposals/README.md b/docs/architecture/design-proposals/README.md
@@ -1,13 +1,21 @@
 # Design Proposals
 
-This folder contain documents/links used to design new features for Kubeapps.
+This folder contains documents/links used to design new features for Kubeapps.
 
 # Links
 
-- Authentication (AuthN) and Authorization (AuthZ)
+- Authentication (AuthN) and Authorization (AuthZ):
     - [Introduction](./authentication-and-authorization.md)
     - [OAuth 2 - OpenID Connect (OIDC) Support](https://docs.google.com/document/d/1YZzLtIbS2copQJgspFiMd0eAhpyt8u19MUSDEvH2X4g)
-- [Dashboard Error Handling](./dashboard/error-handling/error-handling.md)
+- Dashboard:
+    - [Dashboard Error Handling](./dashboard/error-handling/error-handling.md)
+    - [Simpler deployments](./dashboard/deployment-improvements.md)
+    - [Improve UX in application view](./dashboard/application-view-revamp.md)
+    - [Upgrade to Clarity design](./clarity-ui.md)
 - [Notify Available Chart Updates](https://docs.google.com/document/d/1oG9nerd5CurWSIwH33kKCsOCtkSFMgcm8SuTJyuSnxs/)
-- [Simpler deployments](./dashboard/deployment-improvements.md)
-- [Third party integration for adding a chart repository](./third-party-add-repository)
+- [Operators support](./operators-support-poc.md)
+- [Third party integration for adding a chart repository](./third-party-add-repository.md)
+- [Replacing MongoDB support](./replacing-mongodb.md)
+- [Helm 3 support](./helm3.md)
+- [Multicluster support](./multi-cluster-support.md)
+
diff --git a/docs/architecture/design-proposals/helm3.md b/docs/architecture/design-proposals/helm3.md
@@ -14,7 +14,7 @@ We see no reason to implement a proxy for Helm 3, but rather what we call an age
 
 ## Authentication
 
-Since Helm 2 is built on the assumption that the Tiller service runs in-cluster with its own service account (and ["does not provide a way to map user credentials to specific permissions within Kubernetes"](https://helm.sh/docs/securing_installation/#tiller-and-user-permissions)), the only thing Kubeapps was required to provide for authentication with Tiller (when using TLS) was the `ca.crt` file.
+Since Helm 2 is built on the assumption that the Tiller service runs in-cluster with its own service account (and ["does not provide a way to map user credentials to specific permissions within Kubernetes"](https://v2.helm.sh/docs/securing_installation/#tiller-and-user-permissions)), the only thing Kubeapps was required to provide for authentication with Tiller (when using TLS) was the `ca.crt` file.
 For this reason, Kubeapps currently (with Helm 2) authenticates with the Kubernetes API server using the user's bearer token not only when talking directly to the API server, but also to verify permissions before making any request to Tiller.
 
 With Helm 3, all authentication will be handled by the Kubernetes API Server, so none of the above should be an issue.

diff --git a/docs/architecture/overview.md b/docs/architecture/overview.md
@@ -19,11 +19,11 @@ Check more details about the implementation in [this document](/docs/developer/k
 
 ### Apprepository CRD and Controller
 
-Chart repositories in Kubeapps are managed with a `CustomResourceDefinition` called `apprepositories.kubeapps.com`. Each repository added to Kubeapps is an object of type `AppRepository` and the `apprepository-controller` will watch for changes on those type of objects to update the list of available charts to deploy.
+Chart repositories in Kubeapps are managed with a `CustomResourceDefinition` called `apprepositories.kubeapps.com`. Each repository added to Kubeapps is an object of type `AppRepository` and the `apprepository-controller` will watch for changes on those types of objects to update the list of available charts to deploy.
 
 ### `asset-syncer`
 
-The `asset-syncer` component is tool that scans a Helm chart repository and populates chart metadata in a database. This metadata is then served by the `assetsvc` component. Check more details about the implementation in this [document](/docs/developer/asset-syncer.md).
+The `asset-syncer` component is a tool that scans a Helm chart repository and populates chart metadata in a database. This metadata is then served by the `assetsvc` component. Check more details about the implementation in this [document](/docs/developer/asset-syncer.md).
 
 ### `assetsvc`
 

diff --git a/docs/developer/apprepository-controller.md b/docs/developer/apprepository-controller.md
@@ -8,7 +8,7 @@ The `apprepository-controller` is a Kubernetes controller for managing Helm char
 - [Make](https://www.gnu.org/software/make/)
 - [Go programming language](https://golang.org/dl/)
 - [Docker CE](https://www.docker.com/community-edition)
-- [Kubernetes cluster (v1.8+)](https://kubernetes.io/docs/setup/pick-right-solution/)
+- [Kubernetes cluster (v1.8+)](https://kubernetes.io/docs/setup/)
 - [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
 - [Telepresence](https://telepresence.io)
 

diff --git a/docs/developer/asset-syncer.md b/docs/developer/asset-syncer.md
@@ -8,7 +8,7 @@ The `asset-syncer` component is a tool that scans a Helm chart repository and po
 - [Make](https://www.gnu.org/software/make/)
 - [Go programming language](https://golang.org/dl/)
 - [Docker CE](https://www.docker.com/community-edition)
-- [Kubernetes cluster (v1.8+)](https://kubernetes.io/docs/setup/pick-right-solution/). [Minikube](https://github.com/kubernetes/minikbue) is recommended.
+- [Kubernetes cluster (v1.8+)](https://kubernetes.io/docs/setup/). [Minikube](https://github.com/kubernetes/minikube) is recommended.
 - [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
 - [Telepresence](https://telepresence.io)
 

diff --git a/docs/developer/assetsvc.md b/docs/developer/assetsvc.md
@@ -8,7 +8,7 @@ The `assetsvc` component is a micro-service that creates an API endpoint for acc
 - [Make](https://www.gnu.org/software/make/)
 - [Go programming language](https://golang.org/dl/)
 - [Docker CE](https://www.docker.com/community-edition)
-- [Kubernetes cluster (v1.8+)](https://kubernetes.io/docs/setup/pick-right-solution/). [Minikube](https://github.com/kubernetes/minikbue) is recommended.
+- [Kubernetes cluster (v1.8+)](https://kubernetes.io/docs/setup/). [Minikube](https://github.com/kubernetes/minikube) is recommended.
 - [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
 - [Telepresence](https://telepresence.io)
 

diff --git a/docs/developer/dashboard.md b/docs/developer/dashboard.md
@@ -7,7 +7,7 @@ The dashboard is the main UI component of the Kubeapps project. Written in Javas
 - [Git](https://git-scm.com/)
 - [Node 8.x](https://nodejs.org/)
 - [Yarn](https://yarnpkg.com)
-- [Kubernetes cluster (v1.8+)](https://kubernetes.io/docs/setup/pick-right-solution/)
+- [Kubernetes cluster (v1.8+)](https://kubernetes.io/docs/setup/)
 - [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
 - [Docker CE](https://www.docker.com/community-edition)
 - [Telepresence](https://telepresence.io)

diff --git a/docs/developer/kubeops.md b/docs/developer/kubeops.md
@@ -8,7 +8,7 @@ The `kubeops` component is a micro-service that creates an API endpoint for acce
 - [Make](https://www.gnu.org/software/make/)
 - [Go programming language](https://golang.org/dl/)
 - [Docker CE](https://www.docker.com/community-edition)
-- [Kubernetes cluster (v1.8+)](https://kubernetes.io/docs/setup/pick-right-solution/). [Minikube](https://github.com/kubernetes/minikbue) is recommended.
+- [Kubernetes cluster (v1.8+)](https://kubernetes.io/docs/setup/). [Minikube](https://github.com/kubernetes/minikube) is recommended.
 - [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
 
 ## Download the Kubeapps source code

diff --git a/docs/developer/testing-environment.md b/docs/developer/testing-environment.md
@@ -4,16 +4,15 @@ This guide explains how to setup your environment to test Kubeapps integration w
 
 ## Background
 
-Kubeapps can be integrated with other services to extend its capabilities. Find more information about these integrations in the links below:
+Kubeapps can be integrated with other services to extend its capabilities. Find more information about these integrations in the link below:
 
 - [Using Private App Repositories with Kubeapps](../user/private-app-repository.md).
-- [Kubernetes Service Catalog Kubeapps Integration](../user/service-catalog.md).
 
 This guide aims to provide the instructions to easily setup the environment to test these integrations.
 
 ## Prerequisites
 
-- [Kubernetes cluster (v1.12+)](https://kubernetes.io/docs/setup/pick-right-solution/).
+- [Kubernetes cluster (v1.12+)](https://kubernetes.io/docs/setup/).
 - [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/).
 - [Helm client](https://helm.sh/docs/intro/install/).
 

diff --git a/docs/user/access-control.md b/docs/user/access-control.md
@@ -17,7 +17,7 @@ Two of the most common authentication strategies for providing a token identifyi
 
 ### OpenID Connect authentication
 
-The most common and secure authentication for users to authenticate with the cluster (and therefore Kubeapps) is to use the built-in Kubernetes support for OpenID Connect. In this setup your clusters trust an OAuth2 provider such as Azure Active Directory, Google OpenID Connect or your own installation of the Dex auth provider. You can read more about [using an OIDC provider with Kubeapps](../using-an-OIDC-provider.md).
+The most common and secure authentication for users to authenticate with the cluster (and therefore Kubeapps) is to use the built-in Kubernetes support for OpenID Connect. In this setup your clusters trust an OAuth2 provider such as Azure Active Directory, Google OpenID Connect or your own installation of the Dex auth provider. You can read more about [using an OIDC provider with Kubeapps](./using-an-OIDC-provider.md).
 
 ### Service Account authentication
 
@@ -85,7 +85,7 @@ kubectl create -n ${KUBEAPPS_NAMESPACE} rolebinding example-kubeapps-repositorie
 
 > Note: There is also a cluster-role for just allowing people to read app repositories: `kubeapps:${KUBEAPPS_NAMESPACE}:apprepositories-read`.
 
-The above command command allows people to create app repositories in the Kubeapps namespace, these are called "Global Repositories" since they will be available in any namespace Kubeapps is available. On the other hand, it's also possible to create "Namespaced Repositories" that will be available just in a single namespace. For doing so, users need to have permissions to create app repositories in those namespaces. Read the next section to know how to create those roles.
+The above command allows people to create app repositories in the Kubeapps namespace, these are called "Global Repositories" since they will be available in any namespace Kubeapps is available. On the other hand, it's also possible to create "Namespaced Repositories" that will be available just in a single namespace. For doing so, users need to have permissions to create app repositories in those namespaces. Read the next section to know how to create those roles.
 
 ### Assigning roles across multiple namespaces
 

diff --git a/docs/user/dashboard.md b/docs/user/dashboard.md
@@ -1,6 +1,6 @@
 # Using the Dashboard
 
-Once you have [installed Kubeapps in your cluster](https://github.com/kubeapps/kubeapps/tree/master/chart/kubeapps) you can use the Dashboard to start managing and deploying applications in your cluster. Checkout the [Getting Started](../getting-started.md) guide to learn how to access the Dashboard and deploy your first application.
+Once you have [installed Kubeapps in your cluster](https://github.com/kubeapps/kubeapps/tree/master/chart/kubeapps) you can use the Dashboard to start managing and deploying applications in your cluster. Checkout the [Getting Started](./getting-started.md) guide to learn how to access the Dashboard and deploy your first application.
 
 The following sections walk you through some common tasks with the Kubeapps Dashboard.
 
@@ -42,6 +42,6 @@ By default, Kubeapps comes with the Bitnami repository enabled. You can see the
 
 ![Repositories List](../img/dashboard-repos.png)
 
-Add new repositories (for example, your organization's chart repository) by clicking the "Add App Repository" button. Fill the "Add Repository" form using the repository info. For a detailed guide of how to add app repositories, check [this guide](../private-app-repository.md).
+Add new repositories (for example, your organization's chart repository) by clicking the "Add App Repository" button. Fill the "Add Repository" form using the repository info. For a detailed guide of how to add app repositories, check [this guide](./private-app-repository.md).
 
 ![Adding repository](../img/dashboard-add-repo.png)