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

Add Grafana Guide, fixes #33 #41

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

tuminzee
Copy link
Contributor

Fixes #33

Hi @SSmale and @christianmat,

I've made some changes to simplify the steps and omitted certain parts to keep the guide clean. Please review and let me know if you’d like any adjustments to the tone or the direction of the guide.

adding ss for you ref

SCR-20241220-dsji SCR-20241220-dsjy SCR-20241220-dskj SCR-20241220-dskv SCR-20241220-dsls SCR-20241220-dsmb SCR-20241220-dsml

@tuminzee
Copy link
Contributor Author

p.s. I think these are a lot of ss 😆

Copy link

@SSmale SSmale left a comment

Choose a reason for hiding this comment

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

Looks good to me.

Is the dashboard code collapsed by default?

@tuminzee
Copy link
Contributor Author

@SSmale I'm not sure I understand your comment. Could you tell me more about what you mean by 'Is the dashboard code collapsed by default?'

@tuminzee
Copy link
Contributor Author

@SSmale also thank you very much for the brief issue. I used most of the comments in the guide 🕺🏼

@SSmale
Copy link

SSmale commented Dec 20, 2024

@SSmale I'm not sure I understand your comment. Could you tell me more about what you mean by 'Is the dashboard code collapsed by default?'

https://gist.github.com/pierrejoubert73/902cc94d79424356a8d20be2b382e1ab see the first example, the block is closed so you're not greeted with a wall of text that you might not need.

@tuminzee
Copy link
Contributor Author

ah cool cool, this is great let me look how to do this in mintlify
will update the PR

@SSmale
Copy link

SSmale commented Dec 20, 2024

For completeness and to possibly save your sanity, I do not know if it is possible in this projects doc engine.

@tuminzee
Copy link
Contributor Author

commit ref 4d45a90

I tried it it doesn't seem to work in mintlify.
Although I have one observation, the most annoying part right now in the guide is the dashboard json
I can link up the json file which could be downloaded directly? what do you think of that? other parts of the guide are small enough to be present in the same page

image

@christianmat I was not able to link json with relative path imports so for this above image demo. I added the deteminsitic link where the file would be present in the future https://raw.githubusercontent.com/FrigadeHQ/trench/refs/heads/main/apps/docs/json/grafana-dashboard.json (the file would only be available after the merge in the main branch)

let me know what do you think about this approach @SSmale

Also I changed markdown steps to https://mintlify.com/docs/content/components/steps#steps
downside of using mintlify steps is that I was not able to tag steps in url so it might because a problem to share a specific step

@christianmat
Copy link
Contributor

The deep link looks like a good solution to me. Great work. Waiting for @SSmale to confirm it looks good and then we can merge.

@SSmale
Copy link

SSmale commented Dec 23, 2024

Yeah looks like a great solution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

document the grafana queries
3 participants