Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ecosystem] Document registry curation policy and responsibilities #5937

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions content/en/ecosystem/adopters.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,10 @@ OpenTelemetry for [Observability](/docs/concepts/observability-primer/).

{{% ecosystem/adopters-table %}}

## Adding your organization as an adopter {#how-to-add}

To have your organization listed, submit a PR with an entry added to the
[adopters list](https://github.com/open-telemetry/opentelemetry.io/tree/main/data/ecosystem/adopters.yaml).
The entry should include the following:
[adopters list]. The entry should include the following:

- Link to a blog post or other resource that describes how your organization
makes use of OpenTelemetry
Expand All @@ -32,4 +33,9 @@ If your organization provides a **library** or **service** made observable
through OpenTelemetry, see [Integrations](/ecosystem/integrations/).

If your organization provides a solution that consumes OpenTelemetry to offer
**Observability to end users**, see [Vendors](/ecosystem/vendors/).
**Observability to end users**, see [Vendors](/ecosystem/vendors).

{{% ecosystem/keep-up-to-date adopter %}}

[adopters list]:
https://github.com/open-telemetry/opentelemetry.io/tree/main/data/ecosystem/adopters.yaml
10 changes: 7 additions & 3 deletions content/en/ecosystem/distributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,10 @@ is provided as a convenience for the community. {{% /alert %}}

{{% ecosystem/distributions-table %}}

## How to add your distribution {#how-to-add}
## Adding your distribution {#how-to-add}

To have your distribution listed, [submit a PR] with an entry added to the
[distributions list](https://github.com/open-telemetry/opentelemetry.io/tree/main/data/ecosystem/distributions.yaml).
The entry should include the following:
[distributions list]. The entry should include the following:

- Link to the main page of your distribution
- Link to the documentation that explains how to use the distribution
Expand All @@ -48,3 +47,8 @@ The entry should include the following:
{{% /alert %}}

[submit a PR]: /docs/contributing/pull-requests/

{{% ecosystem/keep-up-to-date distribution %}}

[distributions list]:
https://github.com/open-telemetry/opentelemetry.io/tree/main/data/ecosystem/distributions.yaml
4 changes: 3 additions & 1 deletion content/en/ecosystem/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ have a CNCF logo beside their name.

{{% ecosystem/integrations-table "application integrations" %}}

## How to add your integration {#how-to-add}
## Adding your integration {#how-to-add}

To have your library, service, or app listed, [submit a PR] with an entry added
to the [registry](/ecosystem/registry/adding). The entry should include the
Expand All @@ -67,3 +67,5 @@ end users, see [Vendors](/ecosystem/vendors).
{{% /alert %}}

[submit a PR]: /docs/contributing/pull-requests/

{{% ecosystem/keep-up-to-date integration %}}
21 changes: 21 additions & 0 deletions content/en/ecosystem/registry/updating.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Keeping registry and list information current
linkTitle: Updating
---

We periodically review [registry](..) entry and [list data], such as external
links, to ensure that only [adopters](../../adopters/),
[distributions](../../distributions/),
[integrations, libraries](../../integrations/), and [vendors](../../vendors/)
actively supporting OpenTelemetry are included in the registry.

Entry authors are encouraged to maintain links to active and up-to-date
distributions, documentation, and libraries. We reserve the right to update or
remove entries for components that seem to no longer actively support
OpenTelemetry. This may happen, for example, when external links become invalid.
We will attempt to contact the GitHub user who submitted the original entry data
on a best effort basis, but otherwise reserve the right to edit and remove
entries and entry data.

[list data]:
https://github.com/open-telemetry/opentelemetry.io/tree/main/data/ecosystem
10 changes: 7 additions & 3 deletions content/en/ecosystem/vendors.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,10 @@ source product for their customers.

{{% ecosystem/vendor-table %}}

## Add your organization
## Adding your organization {#how-to-add}

To have your organization listed, [submit a PR] with an entry added to the
[vendors list](https://github.com/open-telemetry/opentelemetry.io/tree/main/data/ecosystem/vendors.yaml).
The entry should include the following:
[vendors list]. The entry should include the following:

- Link to the documentation that details how your offering consumes
OpenTelemetry natively via [OTLP](/docs/specs/otlp/).
Expand All @@ -44,3 +43,8 @@ If you provide a library, service, or app that is made observable through
OpenTelemetry, see [Integrations](/ecosystem/integrations/).

[submit a PR]: /docs/contributing/pull-requests/

{{% ecosystem/keep-up-to-date vendor %}}

[vendors list]:
https://github.com/open-telemetry/opentelemetry.io/tree/main/data/ecosystem/vendors.yaml
10 changes: 10 additions & 0 deletions layouts/shortcodes/ecosystem/keep-up-to-date.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{{ $what := .Get 0 | default "organization" -}}

## Keeping {{ $what }} information current

Ensure that you keep your {{ $what }} information up-to-date, otherwise we might
update or remove it from the registry or [ecosystem list]. For details, see
[Keeping registry information current](../registry/updating/).

[ecosystem list]:
https://github.com/open-telemetry/opentelemetry.io/tree/main/data/ecosystem
Loading