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

How do we document & promote non-collector & non-language projects? #1701

Closed
svrnm opened this issue Sep 1, 2022 · 4 comments
Closed

How do we document & promote non-collector & non-language projects? #1701

svrnm opened this issue Sep 1, 2022 · 4 comments
Labels
discussion Input from everyone is helpful to drive this forward docs

Comments

@svrnm
Copy link
Member

svrnm commented Sep 1, 2022

We have a few projects within OTel that are currently not having a proper place within our docs (maybe mentioned somewhere put not as highlighted as the languages & collector):

  • K8s operator + helm charts
  • Lambda
  • Demo
  • OpAMP
  • sql commenter
  • flowmill / ebpf
  • "middleware" instrumentation like Apache & Nginx within CPP Contrib

Let's have a case-by-case discussion if/how/when we want to have them included into the docs.

cc @open-telemetry/docs-approvers

@svrnm svrnm added the question Further information is requested label Sep 1, 2022
@cartermp
Copy link
Contributor

cartermp commented Sep 1, 2022

Great question. Tough one too. I could see the k8s operator being something we document and promote here, especially since it's vendor-neutral. But serverless platforms, despite being prevalent, aren't vendor-neutral and so I'd have to think about how I feel about that.

I guess my initial feelings about what should be documented here:

  • K8s operator + helm charts ✅
  • Lambda
  • Demo ✅
  • OpAMP ✅
  • sql commenter
  • flowmill / ebpf
  • "middleware" instrumentation like Apache & Nginx within CPP Contrib

Then there's cases like sql commenter, which isn't vendor-specific anymore. It's sort of like an autoinstrumentation package. So I guess that could be documented too, but not necessarily more prominently than anything else.

@svrnm
Copy link
Member Author

svrnm commented Sep 2, 2022

Yeah, the items on the list are not equal in the way how/if we should promote them.

I also had the feeling that K8s operator, demo & opamp deserve a prominent place. Those are the one we should focus on

Lambda: yes, I also don't know what a good approach is, maybe have a "serverless" section somewhere, that has all of them (including some of the content we had on knative?)

For sql commenter we could see if it helps to have it on a language level?

I was listing nginx & apache additionally not only because my teams have created them, but also because they point out that you can use opentelemetry to achieve native instrumentation for often-used pre-compiled software as well (envoy, haproxy, etc. would also come to mind), maybe worth a separate discussion.

@svrnm svrnm added discussion Input from everyone is helpful to drive this forward and removed question Further information is requested labels Sep 8, 2022
@cartermp cartermp added the docs label Sep 29, 2022
@svrnm
Copy link
Member Author

svrnm commented Oct 10, 2022

Demo & K8s operator are in now

@svrnm
Copy link
Member Author

svrnm commented Jan 18, 2024

We did some of that 🎉

@svrnm svrnm closed this as completed Jan 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Input from everyone is helpful to drive this forward docs
Projects
None yet
Development

No branches or pull requests

2 participants