Skip to content
This repository has been archived by the owner on Jul 19, 2023. It is now read-only.

Reorganize docs structure #703

Merged
merged 17 commits into from
May 22, 2023
Merged

Reorganize docs structure #703

merged 17 commits into from
May 22, 2023

Conversation

Rperry2174
Copy link
Contributor

@Rperry2174 Rperry2174 commented May 19, 2023

Reorganizing docs structure

image

I made a couple changes to the structure to make it a little more straightforward.

I don't think it helped to nest everything under "operator and user guide" as opposed to having all the potentially options available to users immediately in the sidebar.

I think the most common flow when people come to docs is going to be:

  1. "How do I get started" (overview)
  2. "How do I get started getting profiles from my code"
  3. "How do I set up the server" (if necessary -- in the case of the cloud they won't need this which is why I think client configuration is more important than server)
  4. "how do I deploy it"

And then after that I put everything in "reference" because it's things that people can refer to if they want to, but if users are trying to get started quickly then they can still do that without the reference sections

Copy link
Member

@petethepig petethepig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

We should discuss releasing phlare so that these docs show up by default.

@Rperry2174 Rperry2174 merged commit 982a19f into main May 22, 2023
@Rperry2174 Rperry2174 deleted the reorganize-docs-structure branch May 22, 2023 16:14
simonswine pushed a commit to simonswine/pyroscope that referenced this pull request Jun 30, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants