Skip to content

Commit

Permalink
few changes to make remaining docs consistent
Browse files Browse the repository at this point in the history
  • Loading branch information
SD-13 committed Dec 24, 2022
1 parent 4617cfd commit dd3ecd4
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 3 deletions.
12 changes: 12 additions & 0 deletions docs/website/docs/command-reference/list-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,25 @@ To list bindable services in the current project/namespace:
```shell
odo list services
```
<details>
<summary>Example</summary>

```shell
$ odo list services
✓ Listing bindable services from namespace "myproject" [82ms]

NAME NAMESPACE
redis-standalone/Redis.redis.redis.opstreelabs.in/v1 myproject
```
</details>

To list bindable services in all projects/namespaces accessible to the user:
```shell
odo list services -A
```
<details>
<summary>Example</summary>

```shell
odo list services -A
✓ Listing bindable services from all namespaces [182ms]
Expand All @@ -32,18 +39,23 @@ odo list services -A
redis-standalone/Redis.redis.redis.opstreelabs.in/v1 myproject
hello-world/RabbitmqCluster.rabbitmq.com/v1 newproject
```
</details>

To list bindable services in a particular project/namespace that is accessible to the user:
```shell
odo list services -n <project-name>
```
<details>
<summary>Example</summary>

```shell
$ odo list services -n newproject
✓ Listing bindable services from namespace "newproject" [45ms]

NAME NAMESPACE
hello-world/RabbitmqCluster.rabbitmq.com/v1 newproject
```
</details>

To get the JSON formatted output for any of the above commands, add `-o json` to the commands shown above. That
would be:
Expand Down
4 changes: 2 additions & 2 deletions docs/website/docs/command-reference/set-namespace.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: odo set namespace
## Running the command
To set the current active namespace you can run `odo set namespace <name>`:
```console
odo set namespace mynamespace
odo set namespace <namespace>
```

<details>
Expand All @@ -23,7 +23,7 @@ Optionally, you can also use `project` as an alias to `namespace`.

To set the current active project you can run `odo set project <name>`:
```console
odo set project myproject
odo set project <project>
```

<details>
Expand Down
10 changes: 9 additions & 1 deletion docs/website/docs/user-guides/advanced/experimental-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@ If a feature is labeled as Experimental, this specifically means:
Experimental mode is currently opt-in. You can enable it by setting the `ODO_EXPERIMENTAL_MODE` environment variable to `true` prior to running `odo`.
Doing so unlocks all experimental commands and flags.

Example:
<details>
<summary>Example</summary>

```shell
$ ODO_EXPERIMENTAL_MODE=true odo dev --run-on=some-platform

Expand All @@ -33,16 +35,22 @@ More details on https://odo.dev/docs/user-guides/advanced/experimental-mode
...
- Forwarding from 127.0.0.1:40001 -> 8080
```
</details>

:::info NOTE
Running `odo` with an experimental command or flag without enabling the experimental mode returns an error.

<details>
<summary>Example</summary>

```shell
$ odo dev --run-on=some-platform
...
...
✗ unknown flag: --run-on
```
</details>

:::

## List of experimental features
Expand Down

0 comments on commit dd3ecd4

Please sign in to comment.