alihan/odo
1
0
Fork 0
mirror of https://github.com/redhat-developer/odo.git synced 2025-10-19 03:06:19 +03:00
Code Issues Packages Projects Releases Wiki Activity

Minor fixes to documentation (#6230)

Browse Source 
* Minor fixes to documentation

* Modify the README to highlight odo
This commit is contained in:
Parthvi Vala
2022-10-20 15:01:33 +05:30
committed by GitHub
parent 48e83893e1
commit a88eace7a1
7 changed files with 28 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -22,7 +22,7 @@ Why use `odo`?
* **Containers first:** We provide first class support for both Kubernetes and OpenShift. Choose your favourite container orchestrator and develop your application.
* **Easy to learn:** Simple syntax and design centered around concepts familiar to developers, such as projects, applications, and components.
Learn more about the features provided by odo on [odo.dev](https://odo.dev/docs/overview/features).
Learn more about the features provided by `odo` on [odo.dev](https://odo.dev/docs/overview/features).
----
@@ -63,7 +63,7 @@ We are an open community who welcomes any concerns, changes or ideas for `odo`!
All our calls are open to public. You are welcome to join any of our calls.
You can find the exact dates of all scheduled odo calls together with sprint dates in the [odo calendar](https://calendar.google.com/calendar/embed?src=gi0s0v5ukfqkjpnn26p6va3jfc%40group.calendar.google.com) ([iCal format](https://calendar.google.com/calendar/ical/gi0s0v5ukfqkjpnn26p6va3jfc%40group.calendar.google.com/public/basic.ics)).
You can find the exact dates of all scheduled team calls together with sprint dates in the [google calendar](https://calendar.google.com/calendar/embed?src=gi0s0v5ukfqkjpnn26p6va3jfc%40group.calendar.google.com) ([iCal format](https://calendar.google.com/calendar/ical/gi0s0v5ukfqkjpnn26p6va3jfc%40group.calendar.google.com/public/basic.ics)).
----

8
docs/website/docs/command-reference/build-images.md
View File

@@ -2,9 +2,9 @@
title: odo build-images
---
odo can build container images based on Dockerfiles, and push these images to their registries.
`odo` can build container images based on Dockerfiles, and push these images to their registries.
When running the command `odo build-images`, odo searches for all components in the `devfile.yaml` with the `image` type, for example:
When running the command `odo build-images`, `odo` searches for all components in the `devfile.yaml` with the `image` type, for example:
```
components:
@@ -21,7 +21,7 @@ As indicated in the Devfile specification, `uri` could also be an HTTP or HTTPS
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.
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.
If the `--push` flag is passed to the command, the images will be pushed to their registries after they are built.
@@ -66,4 +66,4 @@ Successfully tagged quay.io/user/myimage:latest
### Faking the image build
You can also fake the image build by exporting `PODMAN_CMD=echo` or `DOCKER_CMD=echo` to your environment. Read [environment variables controlling odo behaviour](../overview/configure.md#environment-variables-controlling-odo-behavior) for more information.
You can also fake the image build by exporting `PODMAN_CMD=echo` or `DOCKER_CMD=echo` to your environment. Read [environment variables controlling `odo` behaviour](../overview/configure.md#environment-variables-controlling-odo-behavior) for more information.

6
docs/website/docs/command-reference/deploy.md
View File

@@ -2,11 +2,11 @@
title: odo deploy
---
odo can be used to deploy components in a similar manner they would be deployed by a CI/CD system,
`odo` can be used to deploy components in a similar manner they would be deployed by a CI/CD system,
by first building the images of the containers to deploy, then by deploying the Kubernetes resources
necessary to deploy the components.
When running the command `odo deploy`, odo searches for the default command of kind `deploy` in the devfile, and executes this command.
When running the command `odo deploy`, `odo` searches for the default command of kind `deploy` in the devfile, and executes this command.
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:
@@ -135,4 +135,4 @@ Your Devfile has been successfully deployed
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 [Substituting variables in odo dev](dev.md#substituting-variables) for more information.
See [Substituting variables in `odo` dev](dev.md#substituting-variables) for more information.

2
docs/website/docs/command-reference/list-component.md
View File

@@ -36,7 +36,7 @@ $ odo list component
`odo list component` makes use of cache for performance reasons. This is the same cache that is referred by `kubectl` command
when you do `kubectl api-resources --cached=true`. As a result, if you were to install an Operator/CRD on the
Kubernetes cluster, and create a resource from it using odo, you might not see it in the `odo list component` output. This
Kubernetes cluster, and create a resource from it using `odo`, you might not see it in the `odo list component` output. This
would be the case for 10 minutes timeframe for which the cache is considered valid. Beyond this 10 minutes, the
cache is updated anyway.

32
docs/website/docs/overview/configure.md
View File

@@ -4,9 +4,9 @@ sidebar_position: 6
---
# Configuration
## Configuring odo global settings
## Configuring global settings
The global settings for odo can be found in `preference.yaml` file; which is located by default in the `.odo` directory of the user's HOME directory.
The global settings for `odo` can be found in `preference.yaml` file; which is located by default in the `.odo` directory of the user's HOME directory.
Example:
@@ -109,27 +109,27 @@ Global preference was successfully updated
</details>
You can use the `--force` (or `-f`) flag to force the unset.
Unsetting a preference key sets it to an empty value in the preference file. odo will use the [default value](./configure#preference-key-table) for such configuration.
Unsetting a preference key sets it to an empty value in the preference file. `odo` will use the [default value](./configure#preference-key-table) for such configuration.
### Preference Key Table
| Preference | Description | Default |
| ------------------ | ------------------------------------------------------------------------------ | ----------- |
| UpdateNotification | Control whether a notification to update odo is shown | True |
| Timeout | Timeout for Kubernetes server connection check | 1 second |
| PushTimeout | Timeout for waiting for a component to start | 240 seconds |
| RegistryCacheTime | For how long (in minutes) odo will cache information from the Devfile registry | 4 Minutes |
| Ephemeral | Control whether odo should create a emptyDir volume to store source code | False |
| ConsentTelemetry | Control whether odo can collect telemetry for the user's odo usage | False |
| Preference | Description | Default |
| ------------------ |--------------------------------------------------------------------------| ----------- |
| UpdateNotification | Control whether a notification to update `odo` is shown | True |
| Timeout | Timeout for Kubernetes server connection check | 1 second |
| PushTimeout | Timeout for waiting for a component to start | 240 seconds |
| RegistryCacheTime | Duration for which `odo` will cache information from the Devfile registry | 4 Minutes |
| Ephemeral | Control whether `odo` should create a emptyDir volume to store source code | False |
| ConsentTelemetry | Control whether `odo` can collect telemetry for the user's `odo` usage | False |
## Managing Devfile registries
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.
`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 [Devfile Registry](https://github.com/devfile/registry-support).
You can connect to publicly available devfile registries, or you can install your own [Devfile Registry](https://devfile.io/docs/2.1.0/building-a-custom-devfile-registry).
You can use the `odo preference <add/remove> registry` command to manage the registries used by odo to retrieve devfile information.
You can use the `odo preference <add/remove> registry` command to manage the registries used by `odo` to retrieve devfile information.
### Adding a registry
@@ -177,13 +177,13 @@ To update a registry, you can delete it and add it again with the updated value.
This is a configuration that normal `odo` users don't need to touch.
Options here are mostly used for debugging and testing `odo` behavior.
### Environment variables controlling odo behavior
### Environment variables controlling `odo` behavior
| Variable | Usage |
|-----------------------------|---------------------------------------------------------------------------------------------------------------------|
| `PODMAN_CMD` | The command executed to run the local podman binary. `podman` by default |
| `DOCKER_CMD` | The command executed to run the local docker binary. `docker` by default |
| `ODO_LOG_LEVEL` | Useful for setting a log level to be used by odo commands. |
| `ODO_LOG_LEVEL` | Useful for setting a log level to be used by `odo` commands. |
| `ODO_DISABLE_TELEMETRY` | Useful for disabling telemetry collection. |
| `GLOBALODOCONFIG` | Useful for setting a different location of global preference file preference.yaml. |
| `ODO_DEBUG_TELEMETRY_FILE` | Useful for debugging telemetry. When set it will save telemetry data to a file instead of sending it to the server. |

2
docs/website/docs/user-guides/advanced/deploy/deploy.md
View File

@@ -2,7 +2,7 @@
title: Deploying an Application
---
In this guide, we will be using odo to deploy to production a "Hello World" application.
In this guide, we will be using `odo` to deploy to production a "Hello World" application.
You are expected to complete the [quickstart](../../quickstart) guide first with the respective example.

2
docs/website/docs/user-guides/quickstart/quickstart.md
View File

@@ -4,7 +4,7 @@ title: Quickstart Guide
# Quickstart Guide
In this guide, we will be using odo to create a "Hello World" application.
In this guide, we will be using `odo` to create a "Hello World" application.
You have the option of choosing from the following frameworks for the quickstart guide:
* [Node.js](nodejs)