Skip to content

Commit

Permalink
Make 3.0.0 the default on the site (#5857)
Browse files Browse the repository at this point in the history
* Make 3.0.0 the default on the site

<!--
Thank you for opening a PR! Here are some things you need to know before submitting:

1. Please read our developer guideline: https://github.com/redhat-developer/odo/wiki/Dev:-odo-Dev-Guidelines
2. Label this PR accordingly with the '/kind' line
3. Ensure you have written and ran the appropriate tests: https://github.com/redhat-developer/odo/wiki/Dev:-Writing-and-running-tests
4. Read how we approve and LGTM each PR: https://github.com/redhat-developer/odo/wiki/Pull-Requests:-Review-guideline

Documentation:

If you are pushing a change to documentation, please read: https://github.com/redhat-developer/odo/wiki/Documentation:-Contributing
-->

**What type of PR is this:**

<!--
Add one of the following kinds:
/kind bug
/kind feature
/kind cleanup
/kind tests

Feel free to use other [labels](https://github.com/redhat-developer/odo/labels) as needed. However one of the above labels must be present or the PR will not be reviewed. This instruction is for reviewers as well.
-->
/kind documentation

**What does this PR do / why we need it:**

* Moves the 3.0.0 documentation to current
* Changes the "intro" page to "introduction" due to limitations of
  docusaurus index paging.

**Which issue(s) this PR fixes:**
<!--
Specifying the issue will automatically close it when this PR is merged
-->

Fixes #5842

**PR acceptance criteria:**

- [X] Documentation

**How to test changes / Special notes to the reviewer:**

Signed-off-by: Charlie Drage <[email protected]>

* fix broken links

* fix more links
  • Loading branch information
cdrage authored Jun 27, 2022
1 parent 33733a0 commit e1a16a6
Show file tree
Hide file tree
Showing 80 changed files with 790 additions and 686 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ Existing tools such as `kubectl` and `oc` are more operations-focused and requir
* Detects changes to local code and deploys it to the cluster automatically, giving instant feedback to validate changes in real time.
* Lists all the available components and services from the cluster.

Learn more about the features provided by odo on [odo.dev](https://odo.dev/docs/getting-started/features).
Learn more about the features provided by odo on [odo.dev](https://odo.dev/docs/overview/features).

### Core concepts

Learn more about core concepts of odo on [odo.dev](https://odo.dev/docs/getting-started/basics).
Learn more about core concepts of odo on [odo.dev](https://odo.dev/docs/overview/basics).


### Usage data
Expand All @@ -42,7 +42,7 @@ Visit [odo.dev](https://odo.dev/) to learn more about odo.

### Installing `odo`

Please check the [installation guide on odo.dev](https://odo.dev/docs/getting-started/installation/).
Please check the [installation guide on odo.dev](https://odo.dev/docs/overview/installation/).


### Community, discussion, contribution, and support
Expand Down
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
3 changes: 1 addition & 2 deletions docs/website/docs/command-reference/build-images.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: odo build-images
sidebar_position: 1
---

odo can build container images based on Dockerfiles, and push these images to their registries.
Expand All @@ -19,7 +18,7 @@ components:

The `uri` field indicates the relative path of the Dockerfile to use, relative to the directory containing the `devfile.yaml`. The devfile specification indicates that `uri` could also be an HTTP URL, but this case is not supported by odo yet.

The `buildContext` indicates the directory used as build context. The default value is `${PROJECTS_ROOT}`.
The `buildContext` indicates the directory used as build context. The default value is `${PROJECT_SOURCE}`.

For each image component, odo executes either `podman` or `docker` (the first one found, in this order), to build the image with the specified Dockerfile, build context and arguments.

Expand Down
10 changes: 8 additions & 2 deletions docs/website/docs/command-reference/deploy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: odo deploy
sidebar_position: 5
---

odo can be used to deploy components in a similar manner they would be deployed by a CI/CD system,
Expand All @@ -12,7 +11,7 @@ The kind `deploy` is supported by the devfile format starting from version 2.2.0

The `deploy` command is typically a *composite* command, composed of several *apply* commands:
- a command referencing an `image` component that, when applied, will build the image of the container to deploy, and push it to its registry,
- a command referencing a [`kubernetes` component](https://devfile.io/docs/devfile/2.2.0/user-guide/adding-kubernetes-component-to-a-devfile.html) that, when applied, will create a Kubernetes resource in the cluster.
- a command referencing a [`kubernetes` component](https://devfile.io/docs/devfile/2.2.0/user-guide/adding-a-kubernetes-or-openshift-component-to-a-devfile) that, when applied, will create a Kubernetes resource in the cluster.

With the following example `devfile.yaml` file, a container image will be built by using the `Dockerfile` present in the directory,
the image will be pushed to its registry and a Kubernetes Deployment will be created in the cluster, using this freshly built image.
Expand Down Expand Up @@ -65,3 +64,10 @@ components:
- name: main
image: {{CONTAINER_IMAGE}}
```

## Sustituting variables

The Devfile can define variables to make the Devfile parameterizable. The Devfile can define values for these variables, and you
can override the values for variables from the command line when running `odo deploy`, using the `--var` and `--var-file` options.

See [Sustituting variables in odo dev](dev.md#sustituting-variables) for more information.
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
File renamed without changes.
Loading

0 comments on commit e1a16a6

Please sign in to comment.