tempo icon indicating copy to clipboard operation
tempo copied to clipboard

Published 20 hours ago • verified publisher icon grafana

Add docs on building your own service graphs

Open ilyamochalov opened this issue 1 year ago • 6 comments

What this PR does: Adds docs on building your own service graphs

Which issue(s) this PR fixes: Fixes #3341

Checklist

  • [ ] Tests updated
  • [x] Documentation added
  • [ ] CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

ilyamochalov avatar Jun 24 '24 00:06 ilyamochalov

CLA assistant check
All committers have signed the CLA.

CLAassistant avatar Jun 24 '24 00:06 CLAassistant

This PR must be merged before a backport PR will be created.

github-actions[bot] avatar Jun 24 '24 16:06 github-actions[bot]

Thank you for the review and feedback @knylander-grafana . All of your corrections were added. Please check again :)

ilyamochalov avatar Jun 26 '24 05:06 ilyamochalov

I can merge this for you, if you like.

knylander-grafana avatar Jun 26 '24 21:06 knylander-grafana

@knylander-grafana we can merge after someone runs docs project locally to check layouts. I tried make docs on my machine but page doesn't load due to some 404s Screenshot 2024-06-27 at 08 42 47

Do you know who can build project and check layouts locally?

ilyamochalov avatar Jun 27 '24 00:06 ilyamochalov

@knylander-grafana we can merge after someone runs docs project locally to check layouts. I tried make docs on my machine but page doesn't load due to some 404s Screenshot 2024-06-27 at 08 42 47

Do you know who can build project and check layouts locally?

I can. :) Which link text and/or file gave you a 404? I'm not finding any so far. Links go outside of the Tempo project will provide a 404. The links that go to pages that aren't built locally won't work. So the link to Grafana's node panel docs time out unless you build both grafana and tempo docs.

I was able to run make docs locally without any errors. I did find some layout issues:

  • Page weights in the Service graphs directory needed to be updated so Custom service graphs appeared after Enable service graphs
  • Alignment of the code example and screenshots needed to align with the numbered lists
  • Updated the page title to be Create custom service graphs so the title indicated that the page is a procedure

knylander-grafana avatar Jun 27 '24 13:06 knylander-grafana

@knylander-grafana thank you for testing and fixes! If you think the page looks good now, we can merge it.

ilyamochalov avatar Jul 02 '24 07:07 ilyamochalov

@ilyamochalov

I introduced this and It is much more better than original service graph.

really thanks

pingping95 avatar Jul 09 '24 16:07 pingping95