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

ADOT docs revamp #64

Open
mhausenblas opened this issue Jun 22, 2022 · 4 comments
Open

ADOT docs revamp #64

mhausenblas opened this issue Jun 22, 2022 · 4 comments
Assignees
Labels
ADOT website ADOT website aws-otel.github.io tech docs requests enhancement New feature or request roadmap ADOT roadmap related issues

Comments

@mhausenblas
Copy link
Member

mhausenblas commented Jun 22, 2022

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

Customer feedback:

@mhausenblas mhausenblas self-assigned this Jun 22, 2022
@mhausenblas mhausenblas pinned this issue Jun 22, 2022
@mhausenblas mhausenblas added enhancement New feature or request roadmap ADOT roadmap related issues ADOT website ADOT website aws-otel.github.io tech docs requests labels Jan 11, 2023
@Ramneek-kalra
Copy link

Ramneek-kalra commented Feb 14, 2024

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
Copy link

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

@simonloach
Copy link

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:

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
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ADOT website ADOT website aws-otel.github.io tech docs requests enhancement New feature or request roadmap ADOT roadmap related issues
Development

No branches or pull requests

3 participants