ADOT docs revamp - Githubissues

mhausenblas commented 2 years ago

Support versioned documentation
Move agnostic content upstream (docs consolidation project in OpenTelemetry)
Simplify and improve the navigation (fewer top-level items, better search and discovery)
Move all product stuff to PDP

Customer feedback:

https://github.com/aws-observability/aws-otel-collector/issues/1480

Ramneek-kalra commented 9 months ago

https://aws-otel.github.io/docs/getting-started/adot-eks-add-on/requirements > Don't know if this is right spot to comment > The cert-manager version being documented is also older one which isn't compatible with latest version of ADOT Add-on. Please revamp that too as per latest shared at: https://cert-manager.io/docs/installation/

Ramneek-kalra commented 8 months ago

@mhausenblas Let me know if we are stepping ahead on this feedback.

simonloach commented 1 month ago

Kudos to author, will raise this as well in EKS Enterprise support. We want to introduce ADOT into our EKS cluster to send metrics from Prometheus and Cloudwatch alongisde Xray Traces.

Right now there is no way to see the most current AWS EKS Addon other than stumbling on AWS Blog post. For anyone interested I found a blog that mentioned "v0.102.0-eksbuild.1" to be latest.

Docs are designed in a way that me trying to configure version "v0.102.0-eksbuild.1" went to https://aws-otel.github.io/docs/getting-started/adot-eks-add-on/add-on-configuration which:

doesnt mention XRay (version lesser than 0.88 has outdated files)
mentions Prometheus but is not descriptive
says to check configuration_values for addon in schema in GUI, whereas guide for versions lesser than 0.88 had a dynamically generated table.
sample App for generating XRay traces does not lead to anywhere with something that could be deployed (https://aws-otel.github.io/docs/getting-started/adot-eks-add-on/config-xray#utilize-a-sample-application-to-generate-trace-data under "Sample Application for Trace Data](https://docs.aws.amazon.com/eks/latest/userguide/sample-app.html")

In order to really understand what I needed to do I had to read all the docs for previous version, review migration guide and then get to current version doc. This is a tedious process, please someone improve this!

Please update the docs with docs for XRay, Prometheus(section on AMP welcome), Cloudwatch setups that would work out of the box.

mhausenblas commented 1 month ago

@simonloach thanks for your feedback and we will take this on board!

aws-observability / aws-otel-community

ADOT docs revamp #64