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

[DOC] Update and evaluate client and server install/config/requirements content #3490

Open
knylander-grafana opened this issue Aug 16, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation type/docs Improvements for doc docs. Used by Docs team for project management

Comments

@knylander-grafana
Copy link
Contributor

knylander-grafana commented Aug 16, 2024

Our configuration doc is missing information about supported architecture and hardware requirements. We have install/configure content in the Get started, Configure the client to send profiles, Upgrade, Deploy on Kubernetes, and Configure the server.

Short term:

  • Add a section to the both the Client and Server sections that lists supported architecture with links to various requirement and supported storage options

Long term (in a new doc issue):

  • Create a "Plan your deployment" page that provides a summary of installation instructions, follow Tempo's outline as an example
  • Review and restructure the client and server docs so they provide a clear path for users who want to instrument apps and set up their server.
    • Simplify the TOC topics so the navigation is clearer for people wanting to install and configure the client (instrument) and store profile data (Pyroscope set up).

Related:

@knylander-grafana knylander-grafana added type/docs Improvements for doc docs. Used by Docs team for project management documentation Improvements or additions to documentation labels Aug 16, 2024
@knylander-grafana knylander-grafana changed the title [DOC] Update and evaluate slient and server install config content [DOC] Update and evaluate client and server install/config/requirements content Aug 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation type/docs Improvements for doc docs. Used by Docs team for project management
Projects
None yet
Development

No branches or pull requests

1 participant