Skip to content

Commit

Permalink
fix broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
cdrage committed Jun 24, 2022
1 parent b72d9f7 commit d47fcd8
Show file tree
Hide file tree
Showing 15 changed files with 28 additions and 29 deletions.
4 changes: 2 additions & 2 deletions docs/website/blog/2020-09-24-odo-v2.0.0-ga-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ slug: odo-200-release

[Devfile](https://devfile.github.io/) is a file format that is used as odo's new deployment engine. Starting from `2.0.0` onwards, Source-to-Image (S2I) is no longer the default deployment method. S2I is still supported and can now be accessed with the `--s2i` flag from the command-line.

Learn how to deploy your first devfile using devfiles from our [Devfile tutorial](../docs/getting-started/quickstart).
Learn how to deploy your first devfile using devfiles from our [Devfile tutorial](/docs/2.5.0/getting-started/quickstart).

Example on how to download a starter project and deploy a devfile:

Expand Down Expand Up @@ -61,7 +61,7 @@ Pushing devfile component nodejs

With the release of `2.0.0` deploying operators is now out of experimental mode.

Learn how to deploy your first Kubernetes custom controller from our [installation guide](../docs/getting-started/cluster-setup/kubernetes).
Learn how to deploy your first Kubernetes custom controller from our [installation guide](/docs/2.5.0/getting-started/cluster-setup/kubernetes).

Example on how to deploy your first Operator:

Expand Down
2 changes: 1 addition & 1 deletion docs/website/blog/2022-06-14-binding-external-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ stringData:
To be able to *mount* the values of this secret from any namespace, you can use the *Service Binding Operator* (SBO for short), so each developer can define a ServiceBinding resource
between the service and its application, and get the values of the secret (and other values) mounted into its application's Pod.

You can find information about the Service Binding Operator [here](/docs/getting-started/cluster-setup/kubernetes#optional-installing-the-service-binding-operator).
You can find information about the Service Binding Operator [here](/docs/overview/cluster-setup/kubernetes).

A ServiceBinding defines a binding between an *Application* and a *Service*. The credentials injected into the application
can be defined in different ways:
Expand Down
2 changes: 1 addition & 1 deletion docs/website/docs/command-reference/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: odo dev

`odo dev` is used in order to quickly and effectively iterate through your development process for building an application.

This is [inner loop](../overview/intro#what-is-inner-loop-and-outer-loop) development and allows you to code, build, run and test the application in a continuous workflow.
This is [inner loop](../introduction#what-is-inner-loop-and-outer-loop) development and allows you to code, build, run and test the application in a continuous workflow.

## Running the Command

Expand Down
2 changes: 1 addition & 1 deletion docs/website/docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ We abstract the complex concepts of Kubernetes so you can focus on one thing: `c

Choose your favourite framework and `odo` will deploy it *fast* and *often* to your container orchestrator cluster.

`odo` is focused on [inner loop](./intro#what-is-inner-loop-and-outer-loop) development as well as tooling that would help users transition to the [outer loop](./intro#what-is-inner-loop-and-outer-loop).
`odo` is focused on [inner loop](./introduction#what-is-inner-loop-and-outer-loop) development as well as tooling that would help users transition to the [outer loop](./introduction#what-is-inner-loop-and-outer-loop).

Brendan Burns, one of the co-founders of Kubernetes, said in the [book Kubernetes Patterns](https://www.redhat.com/cms/managed-files/cm-oreilly-kubernetes-patterns-ebook-f19824-201910-en.pdf):

Expand Down
2 changes: 1 addition & 1 deletion docs/website/docs/overview/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Installation
sidebar_position: 4
---

`odo` can be used as either a [CLI tool](/docs/getting-started/installation#cli-binary-installation) or an [IDE plugin](/docs/getting-started/installation#ide-installation) on Mac, Windows or Linux.
`odo` can be used as either a [CLI tool](./installation#cli-binary-installation) or an [IDE plugin](./installation#ide-installation) on Mac, Windows or Linux.

## CLI installation

Expand Down
5 changes: 2 additions & 3 deletions docs/website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,11 @@ module.exports = {
items: [
{
label: 'Installation',
to: 'docs/getting-started/installation'
to: 'docs/overview/installation'
},
{
label: 'Quickstart',
to: 'docs/getting-started/quickstart'
to: 'docs/user-guides/quickstart'
},
]
},
Expand Down Expand Up @@ -129,7 +129,6 @@ module.exports = {
current: {
label: '3.0.0 (Alpha 2) 🚧',
badge: true,
banner: 'unreleased',
},
'2.5.0': {
label: '2.5.0 (Stable) 🚀',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ odo uses different *catalogs* to deploy *components* and *services*.

## Components

odo uses the portable *devfile* format to describe the components. It can connect to various devfile registries to download devfiles for different languages and frameworks. See [`odo registry`](/docs/command-reference/registry) for more information.
odo uses the portable *devfile* format to describe the components. It can connect to various devfile registries to download devfiles for different languages and frameworks. See [`odo registry`](../command-reference/registry) for more information.

### Listing components

Expand Down Expand Up @@ -65,13 +65,13 @@ projectsource:

*Registry* is the registry from which the devfile is retrieved.

*Starter projects* are sample projects in the same language and framework of the devfile, that can help you start a new project. See [`odo create`](/docs/command-reference/create) for more information on creating a project from a starter project.
*Starter projects* are sample projects in the same language and framework of the devfile, that can help you start a new project. See [`odo create`](../command-reference/create) for more information on creating a project from a starter project.

## Services

odo can deploy *services* with the help of *operators*.

Only operators deployed with the help of the [*Operator Lifecycle Manager*](https://olm.operatorframework.io/) are supported by odo. See [Installing the Operator Lifecycle Manager (OLM)](/docs/getting-started/cluster-setup/kubernetes#installing-the-operator-lifecycle-manager-olm) for more information.
Only operators deployed with the help of the [*Operator Lifecycle Manager*](https://olm.operatorframework.io/) are supported by odo. See [Installing the Operator Lifecycle Manager (OLM)](../getting-started/cluster-setup/kubernetes#installing-the-operator-lifecycle-manager-olm) for more information.


### Listing services
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ sidebar_position: 7

`odo link` command helps link an odo component to an Operator backed service or another odo component. It does this by using [Service Binding Operator](https://github.com/redhat-developer/service-binding-operator). At the time of writing this, odo makes use of the Service Binding library and not the Operator itself to achieve the desired functionality.

In this document we will cover various options to create link between a component & a service, and a component & another component. The steps in this document are going to be based on the [odo quickstart project](https://github.com/dharmit/odo-quickstart/) that we covered in [Quickstart guide](/docs/getting-started/quickstart). The outputs mentioned in this document are based on commands executed on [minikube cluster](/docs/getting-started/cluster-setup/kubernetes).
In this document we will cover various options to create link between a component & a service, and a component & another component. The steps in this document are going to be based on the [odo quickstart project](https://github.com/dharmit/odo-quickstart/) that we covered in [Quickstart guide](../getting-started/quickstart). The outputs mentioned in this document are based on commands executed on [minikube cluster](../getting-started/cluster-setup/kubernetes).

This document assumes that you know how to [create components](/docs/command-reference/create) and [services](/docs/command-reference/service). It also assumes that you have cloned the [odo quickstart project](https://github.com/dharmit/odo-quickstart/). Terminology used in this document:
This document assumes that you know how to [create components](../command-reference/create) and [services](../command-reference/service). It also assumes that you have cloned the [odo quickstart project](https://github.com/dharmit/odo-quickstart/). Terminology used in this document:

- *quickstart project*: git clone of the odo quickstart project having below directory structure:
```shell
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 8

odo uses the portable *devfile* format to describe the components. odo can connect to various devfile registries to download devfiles for different languages and frameworks.

You can connect to publicly available devfile registries, or you can install your own [Secure Registry](/docs/architecture/secure-registry).
You can connect to publicly available devfile registries, or you can install your own [Secure Registry](../architecture/secure-registry).

You can use the `odo registry` command to manage the registries used by odo to retrieve devfile information.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ sidebar_position: 9

odo can deploy *services* with the help of *operators*.

The list of available operators and services available for installation can be found with the [`odo catalog` command](/docs/command-reference/catalog).
The list of available operators and services available for installation can be found with the [`odo catalog` command](../command-reference/catalog).

Services are created in the context of a *component*, so you should have run [`odo create`](/docs/command-reference/create) before you deploy services.
Services are created in the context of a *component*, so you should have run [`odo create`](../command-reference/create) before you deploy services.

The deployment of a service is done in two steps:
1. Define the service and store its definition in the devfile,
Expand Down Expand Up @@ -156,7 +156,7 @@ spec:
image: quay.io/opstree/redis-exporter:1.0
```

You can obtain the possible parameters for a specific service from the [`odo catalog describe service` command](/docs/command-reference/catalog/#getting-information-about-a-service).
You can obtain the possible parameters for a specific service from the [`odo catalog describe service` command](../command-reference/catalog/#getting-information-about-a-service).

#### Using a file

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This guide is helpful in setting up a development environment intended to be use
* You have a Kubernetes cluster set up (such as [minikube](https://minikube.sigs.k8s.io/docs/start/))
* You have admin privileges to the cluster

**Important notes:** `odo` will use the __default__ ingress and storage provisioning on your cluster. If they have not been set correctly, see our [troubleshooting guide](/docs/getting-started/cluster-setup/kubernetes#troubleshooting) for more details.
**Important notes:** `odo` will use the __default__ ingress and storage provisioning on your cluster. If they have not been set correctly, see our [troubleshooting guide](../cluster-setup/kubernetes#troubleshooting) for more details.

## Summary
* An Ingress controller in order to use `odo url create`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Installation
sidebar_position: 3
---

`odo` can be used as either a [CLI tool](/docs/getting-started/installation#cli-binary-installation) or an [IDE plugin](/docs/getting-started/installation#ide-installation) on Mac, Windows or Linux.
`odo` can be used as either a [CLI tool](../getting-started/installation#cli-binary-installation) or an [IDE plugin](../getting-started/installation#ide-installation) on Mac, Windows or Linux.

## CLI installation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ At the end of the guide, you will be able to list, add and delete to-do items fr
## Prerequisites

* Have the odo binary [installed](./installation.md).
* A [Kubernetes cluster](/docs/getting-started/cluster-setup/kubernetes) set up with a [ingress controller](/docs/getting-started/cluster-setup/kubernetes#installing-an-ingress-controller), [operator lifecycle manager](/docs/getting-started/cluster-setup/kubernetes#installing-the-operator-lifecycle-manager-olm) and (optional) [service binding operator](/docs/getting-started/cluster-setup/kubernetes#installing-the-service-binding-operator).
* Or a [OpenShift cluster](/docs/getting-started/cluster-setup/openshift) set up with the (optional) [service binding operator](/docs/getting-started/cluster-setup/openshift#installing-the-service-binding-operator)
* A [Kubernetes cluster](../getting-started/cluster-setup/kubernetes) set up with a [ingress controller](../getting-started/cluster-setup/kubernetes#installing-an-ingress-controller), [operator lifecycle manager](../getting-started/cluster-setup/kubernetes#installing-the-operator-lifecycle-manager-olm) and (optional) [service binding operator](../getting-started/cluster-setup/kubernetes#installing-the-service-binding-operator).
* Or a [OpenShift cluster](../getting-started/cluster-setup/openshift) set up with the (optional) [service binding operator](../getting-started/cluster-setup/openshift#installing-the-service-binding-operator)

## Clone the quickstart guide

Expand Down Expand Up @@ -109,7 +109,7 @@ Note, you will not be able to access `http://<YOUR-URL>/api/v1/todos` yet until

Use `odo catalog list services` to list all available operators.

By default, [Operator Lifecycle Manager (OLM)](/docs/getting-started/cluster-setup/kubernetes#installing-the-operator-lifecycle-manager-olm) includes no Operators and they must be installed via [Operator Hub](https://operatorhub.io/)
By default, [Operator Lifecycle Manager (OLM)](../getting-started/cluster-setup/kubernetes#installing-the-operator-lifecycle-manager-olm) includes no Operators and they must be installed via [Operator Hub](https://operatorhub.io/)

Install the [Postgres Operator](https://operatorhub.io/operator/postgresql) on the cluster:
```shell
Expand All @@ -128,7 +128,7 @@ NAME CRDs
postgresoperator.v5.0.3 PostgresCluster
```

If you don't see the PostgreSQL Operator listed yet, it may still be installing. Check out our [Operator troubleshooting guide](/docs/getting-started/cluster-setup/kubernetes#checking-to-see-if-an-operator-has-been-installed) for more information.
If you don't see the PostgreSQL Operator listed yet, it may still be installing. Check out our [Operator troubleshooting guide](../getting-started/cluster-setup/kubernetes#checking-to-see-if-an-operator-has-been-installed) for more information.

[//]: # (This needs to fixed in the future and a parameter-based command added rather than a .yaml file)
[//]: # (Right now this is blocked on: https://github.com/redhat-developer/odo/issues/5215)
Expand Down Expand Up @@ -223,4 +223,4 @@ curl http://<URL-OUTPUT>/api/v1/todos

## Further reading

Want to learn what else `odo` can do? Check out the [Tutorials](/docs/intro) on the sidebar.
Want to learn what else `odo` can do? Check out the [Tutorials](../introduction) on the sidebar.
2 changes: 1 addition & 1 deletion docs/website/versioned_docs/version-2.5.0/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ We abstract the complex concepts of Kubernetes so you can focus on one thing: `c

Choose your favourite framework and `odo` will deploy it *fast* and *often* to your container orchestrator cluster.

`odo` is focused on [inner loop](./intro#what-is-inner-loop-and-outer-loop) development as well as tooling that would help users transition to the [outer loop](./intro#what-is-inner-loop-and-outer-loop).
`odo` is focused on [inner loop](./introduction#what-is-inner-loop-and-outer-loop) development as well as tooling that would help users transition to the [outer loop](./introduction#what-is-inner-loop-and-outer-loop).

Brendan Burns, one of the co-founders of Kubernetes, said in the [book Kubernetes Patterns](https://www.redhat.com/cms/managed-files/cm-oreilly-kubernetes-patterns-ebook-f19824-201910-en.pdf):

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ http-3000 Pushed http://http-3000-app-myproject.hostname.com 3000

## Kubernetes

If you are using a Kubernetes cluster, you will have to create a URL using `odo url` command. This is because odo can not assume the host information to be used to create a URL. To be able to create URLs on a Kubernetes cluster, please make sure that you have [Ingress Controller](/docs/getting-started/cluster-setup/kubernetes/#enabling-ingress) installed.
If you are using a Kubernetes cluster, you will have to create a URL using `odo url` command. This is because odo can not assume the host information to be used to create a URL. To be able to create URLs on a Kubernetes cluster, please make sure that you have [Ingress Controller](../getting-started/cluster-setup/kubernetes/#enabling-ingress) installed.

If you are working on a [minikube](/docs/getting-started/cluster-setup/kubernetes), Ingress can be enabled using:
If you are working on a [minikube](../getting-started/cluster-setup/kubernetes), Ingress can be enabled using:
```shell
minikube addons enable ingress
```
Expand Down Expand Up @@ -63,4 +63,4 @@ odo push
Again, if you would prefer to get this done in a single command:
```shell
odo url create --port 3000 --host $(minikube ip).nip.io --now
```
```

0 comments on commit d47fcd8

Please sign in to comment.