Move mermaid diagrams out of markdown files #171
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jdbaldry
reviewed
Jul 11, 2023
docs/docs.mk
Outdated
| @@ -115,3 +115,7 @@ update: ## Fetch the latest version of this Makefile and the `make-docs` script | |||
| curl -s -LO https://raw.githubusercontent.com/grafana/writers-toolkit/main/docs/docs.mk | |||
| curl -s -LO https://raw.githubusercontent.com/grafana/writers-toolkit/main/docs/make-docs | |||
| chmod +x make-docs | |||
|
|
|||
| .PHONY: mermaid | |||
There was a problem hiding this comment.
Nice!
I would move this to Makefile because this file is automatically updated from the centralized source in Writers' Toolkit which will wipe out your changes. Makefile is left untouched by the update process and is the place for repo specific targets.
Codecov Report
@@ Coverage Diff @@
## main #171 +/- ##
===========================================
- Coverage 81.46% 39.08% -42.39%
===========================================
Files 35 34 -1
Lines 2466 2410 -56
===========================================
- Hits 2009 942 -1067
- Misses 337 1410 +1073
+ Partials 120 58 -62
Flags with carried forward coverage won't be shown. Click here to find out more. |
mattdurham
pushed a commit
to mattdurham/beyla
that referenced
this pull request
Jan 22, 2025
* Move mermaid diagrams out of markdown files * Moved make mermaid to root Makefile * Moved make mermaid to the correct makefile * fix typo
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Github automatically renders embedded mermaid diagrams but the Hugo distribution in Grafana Docs doesn't, so I moved them out of the markdown sources and added a new make target that regenerates all the PNGs:
This needs to be run manually after the diagram sources change.