docs: further guidelines around adding extra scripts and assets #19
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
Jun 25, 2024
docs/transformer.md
Outdated
| If your tutorial requires scripts or extra files, make sure to manually add them to the tutorial directory in the Killercoda repository. For example, if your tutorial requires a script to run: | ||
|
|
||
| 1. Add the bash script to the tutorial directory in the Killercoda repository. See the [what-is-loki](../loki/what-is-loki/) tutorial for an example. | ||
| 2. Add the script to the `scripts` field in the `index.json` file: |
There was a problem hiding this comment.
You can use repetitive numbering and let the renderer auto increment for you which makes it easier to update steps: https://grafana.com/docs/writers-toolkit/write/markdown-guide/#numbered-lists
I'm a bit confused by the example because it doesn't reference the scripts field. JSON is very hard to demonstrate in the docs though and you have to be very verbose to help a user: https://grafana.com/docs/writers-toolkit/write/style-guide/write-for-developers/#partial-code-examples so I understand there may not be much you can do
There was a problem hiding this comment.
This is really good point let me flesh this out a little better!
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
jdbaldry
approved these changes
Jun 25, 2024
jdbaldry
approved these changes
Jun 26, 2024
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
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.
Added: