grafana / explore-profiles

Explore Profiles is a native Grafana application designed to integrate seamlessly with Pyroscope, the open-source continuous profiling platform, providing a smooth, query-less experience for browsing and analyzing profiling data.

GNU Affero General Public License v3.0

18 stars 1 forks source link

docs: Update readme markdown #183

Closed bryanhuhta closed 1 month ago

bryanhuhta commented 1 month ago

This leverages a more stylized version of markdown admonition.

Options are:

NOTE

This is fine, but lacks emphasis.

IMPORTANT

Strikes a nice balance between emphasis but doesn't make it seem "dangerous".

WARNING

Technically the appropriate level according to GitHub's recommendation, but I think it suggests using Explore Profiles is "dangerous," which is strictly not true as it remains quite stable.

bryanhuhta commented 1 month ago

@09jvilla I didn't want to step on your toes with your previous change, but I think this provides a more professional looking admonition.

github-actions[bot] commented 1 month ago

Unit test coverage

Lines	Statements	Branches	Functions
	10.67% (413/3868)	8.32% (111/1333)	8.2% (100/1219)

09jvilla commented 1 month ago

This is a great improvement! Thank you for suggesting @bryanhuhta