Skip to content

Commit

Permalink
chore: rename keyval to odigos in docs (#1171)
Browse files Browse the repository at this point in the history
  • Loading branch information
blumamir committed May 6, 2024
1 parent 7734df8 commit 9aeb45b
Show file tree
Hide file tree
Showing 13 changed files with 26 additions and 26 deletions.
10 changes: 5 additions & 5 deletions docs/adding-new-dest.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ const Vendors = [/* List of existing vendors... */ new MyDest()];
```
For a complete UI implementation example, see
[one of our existing vendors](https://github.com/keyval-dev/odigos/tree/main/ui/vendors).
[one of our existing vendors](https://github.com/odigos-io/odigos/tree/main/ui/vendors).
## Collector Configuration
Expand All @@ -150,9 +150,9 @@ need to implement the collector configuration.
package config

import (
odigosv1 "github.com/keyval-dev/odigos/api/v1alpha1"
commonconf "github.com/keyval-dev/odigos/autoscaler/controllers/common"
"github.com/keyval-dev/odigos/common"
odigosv1 "github.com/odigos-io/odigos/api/v1alpha1"
commonconf "github.com/odigos-io/odigos/autoscaler/controllers/common"
"github.com/odigos-io/odigos/common"
)

type MyDest struct{}
Expand Down Expand Up @@ -203,5 +203,5 @@ var availableConfigers = []Configer{/* List of existing destinations */, &MyDes
That’s it! Now you can use your new destination in the UI and send data to it.
**Please submit a PR to the
[odigos git repository](https://github.com/keyval-dev/odigos), we are happy to
[odigos git repository](https://github.com/odigos-io/odigos), we are happy to
accept new destinations.**
4 changes: 2 additions & 2 deletions docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
},
"topbarCtaButton": {
"type": "github",
"url": "https://github.com/keyval-dev/odigos"
"url": "https://github.com/odigos-io/odigos"
},
"anchors": [
{
Expand Down Expand Up @@ -162,7 +162,7 @@
],
"footerSocials": {
"X": "https://twitter.com/odigosio",
"github": "https://github.com/keyval-dev/odigos",
"github": "https://github.com/odigos-io/odigos",
"slack": "https://odigos.slack.com/join/shared_invite/zt-1d7egaz29-Rwv2T8kyzc3mWP8qKobz~A#/shared-invite/email"
}
}
2 changes: 1 addition & 1 deletion docs/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Overview"
sidebarTitle: "Overview"
---

Odigos is an [open-source](https://github.com/keyval-dev/odigos) observability control plane.
Odigos is an [open-source](https://github.com/odigos-io/odigos) observability control plane.
The project's two main goals are:

1. **Automatic instrumentation** - Odigos automatically instruments your
Expand Down
4 changes: 2 additions & 2 deletions docs/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@keyval-dev/odigos-docs",
"name": "@odigos/odigos-docs",
"version": "1.0.0",
"private": true,
"description": "The content and configuration powering the Odigos documentation is available at [docs.odigos.io](https://docs.odigos.io)",
Expand Down
2 changes: 1 addition & 1 deletion docs/pipeline/actions/crd.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This option is for advanced users who are familiar with the OpenTelemetry Collec

You can define OpenTelemetry Collector Processors in Odigos using the `Processor` kubernetes CRD.

You can browse the full list of processors that Odigos includes [here](https://github.com/keyval-dev/odigos/blob/main/collector/builder-config.yaml#L64).
You can browse the full list of processors that Odigos includes [here](https://github.com/odigos-io/odigos/blob/main/collector/builder-config.yaml#L64).
To view the configuration for each processor, it is recommended to visit the README of this component in [OpenTelemetry Collector Contrib codebase](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor).

Adding a processor to your Odigos pipeline can be done by creating a `processor` custom resource in your k8s cluster under odigos namespace, for example:
Expand Down
2 changes: 1 addition & 1 deletion docs/pipeline/sources/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,6 @@ and which processes should be instrumented with eBPF.

## Getting Help

If you are still having trouble, please open an issue in [GitHub](https://github.com/keyval-dev/odigos) or reach out to us in [Odigos Slack](https://join.slack.com/t/odigos/shared_invite/zt-24u91yknm-0fLXu6qnqYfNHS_GSUgTJw)
If you are still having trouble, please open an issue in [GitHub](https://github.com/odigos-io/odigos) or reach out to us in [Odigos Slack](https://join.slack.com/t/odigos/shared_invite/zt-24u91yknm-0fLXu6qnqYfNHS_GSUgTJw)


4 changes: 2 additions & 2 deletions docs/quickstart/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ is a single binary that can be installed on any Linux, MacOS or Windows machine.
If you are on MacOS, you can install Odigos CLI using Homebrew:

```bash
brew install keyval-dev/homebrew-odigos-cli/odigos
brew install odigos-io/homebrew-odigos-cli/odigos
```
</Tab>
<Tab title="GitHub Releases">
Download the latest release from the [GitHub Releases](https://github.com/keyval-dev/odigos/releases)
Download the latest release from the [GitHub Releases](https://github.com/odigos-io/odigos/releases)
page and extract the binary to a directory in your `PATH`.

</Tab>
Expand Down
6 changes: 3 additions & 3 deletions docs/quickstart/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Create a new local Kubernetes cluster, by running the following command:

### Deploying the target application

We are going to install a [demo application](https://github.com/keyval-dev/simple-demo) that consists of 5 microservices written in Go, Java, Python, .NET and Node.js.
We are going to install a [demo application](https://github.com/odigos-io/simple-demo) that consists of 5 microservices written in Go, Java, Python, .NET and Node.js.

<Frame>
<img src="/images/demo_architecture.png" alt="Architecture of demo application" />
Expand All @@ -44,7 +44,7 @@ We are going to install a [demo application](https://github.com/keyval-dev/simpl
Deploy the application using the following command:

```bash
kubectl apply -f https://raw.githubusercontent.com/keyval-dev/simple-demo/main/kubernetes/deployment.yaml
kubectl apply -f https://raw.githubusercontent.com/odigos-io/simple-demo/main/kubernetes/deployment.yaml
```

### Deploying Jaeger
Expand All @@ -54,7 +54,7 @@ Jaeger is a popular open source distributed tracing backend. We are going to use
Install Jaeger using the following command:

```bash
kubectl apply -f https://raw.githubusercontent.com/keyval-dev/simple-demo/main/kubernetes/jaeger.yaml
kubectl apply -f https://raw.githubusercontent.com/odigos-io/simple-demo/main/kubernetes/jaeger.yaml
```

### Waiting for the applications to start
Expand Down
6 changes: 3 additions & 3 deletions docs/setup/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ Before proceeding with the installation, ensure that you are targeting the corre
If you are on MacOS, you can install Odigos CLI using Homebrew:

```bash
brew install keyval-dev/homebrew-odigos-cli/odigos
brew install odigos-io/homebrew-odigos-cli/odigos
```
</Tab>
<Tab title="GitHub Releases">
Download the latest release from the [GitHub Releases](https://github.com/keyval-dev/odigos/releases)
Download the latest release from the [GitHub Releases](https://github.com/odigos-io/odigos/releases)
page and extract the binary to a directory in your `PATH`.

</Tab>
Expand All @@ -52,7 +52,7 @@ At this point, odigos is installed in your cluster. You can now add sources and
### Add Helm Repoistory

```shell
helm repo add odigos https://keyval-dev.github.io/odigos-charts/
helm repo add odigos https://odigos-io.github.io/odigos-charts/
```

### Install Odigos
Expand Down
4 changes: 2 additions & 2 deletions docs/setup/upgrade.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ First, upgrade the CLI tool to latest version:
<Tabs>
<Tab title="Homebrew">
```shell
brew update && brew install keyval-dev/homebrew-odigos-cli/odigos
brew update && brew install odigos-io/homebrew-odigos-cli/odigos
```
</Tab>
<Tab title="GitHub Releases">
Download the latest release from the [GitHub Releases](https://github.com/keyval-dev/odigos/releases)
Download the latest release from the [GitHub Releases](https://github.com/odigos-io/odigos/releases)
page and extract the binary to a directory in your `PATH`.
</Tab>
</Tabs>
Expand Down
2 changes: 1 addition & 1 deletion docs/telemetry-types.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ libraries for every language:
</svg>
}
color="#F7DF1E"
href="https://github.com/keyval-dev/opentelemetry-go-instrumentation/tree/master/pkg/instrumentors/bpf"
href="https://github.com/odigos-io/opentelemetry-go-instrumentation/tree/master/pkg/instrumentors/bpf"
>
opentelemetry-go-instrumentation/pkg/ instrumentors/bpf/
</Card>
Expand Down
4 changes: 2 additions & 2 deletions docs/uninstall.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ title: "Uninstall"

### Uninstalling Odigos

Install the [Odigos CLI](https://github.com/keyval-dev/odigos/tree/main/cli) and execute the following command:
Install the [Odigos CLI](https://github.com/odigos-io/odigos/tree/main/cli) and execute the following command:

```bash
odigos uninstall
Expand All @@ -19,4 +19,4 @@ odigos uninstall
### Reporting Bugs

Please help us make Odigos better by reporting any bugs you find. You can do so
by opening an issue on our [GitHub](https://github.com/keyval-dev/odigos/issues/new/choose)
by opening an issue on our [GitHub](https://github.com/odigos-io/odigos/issues/new/choose)

0 comments on commit 9aeb45b

Please sign in to comment.