docs: Getting started sandbox #4045
Conversation
|
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
@Jayclifford345 This is SO cool! I love having this done. |
|
Hahahha no worries @knylander-grafana! It was really fun, I am just working through a PR with @jdbaldry within the transformer and once we merge that I can put this green for your review :) |
Jayclifford345
requested review from
joe-elliott,
annanay25,
mdisibio,
mapno,
yvrhdn,
zalegrala,
electron0zero,
ie-pham and
stoewer
as code owners
|
Okay @knylander-grafana, we are ready for your review! |
@Jayclifford345 What is the best way for me to review this PR? Are there things I should test for the automated content updates or just check out and build locally? |
You primarily want to check that none of the INTERACTIVE directives have damaged the rendered documentation page. I think Jay will check on his side that the transformed tutorial looks good. |
|
Also, it would be great to have a technical writer review any of the instructional copy even if it doesn't end up in the documentation page so that it conforms to our style and is clear for the users of the course. |
Co-authored-by: Jack Baldry <[email protected]>
Co-authored-by: Jack Baldry <[email protected]>
Co-authored-by: Jack Baldry <[email protected]>
…tempo into sandbox-getting-started
|
I've resolved most of the issues in the PR. Per Jack's suggestion, I've asked for another writer to review the PR. I'll clear the request changes after the other PR review. |
|
This PR must be merged before a backport PR will be created. |
Oh I didn't mean another technical writer necessarily but I do think peer review is a good way to share knowledge and practice :) |
Co-authored-by: Kim Nylander <[email protected]>
|
Hi all, I have removed the image for the Interactive learning environment. I agree with Kim and I am now in an artistic crisis over my own banner design :D. So, I will drop a note to the design team to see if we can get something less intrusive created but still indicate these sandboxes are part of the larger interactive learning effort |
|
I think for now however we can go without the image. So happy for it to be merged when ready |
I lke the idea of the banner. The current design is a bit overwhelming on the documentation page. Do you have banners on the other Killer coda tutorial doc pages within the documentation or only on the Killer Coda published sites? Is it enough to use the text on the product documentation and maybe have the banner only on the Killer Coda site? Does makes more sense to brand it more in that context? |
|
|
||
|
|
||
| Provide feedback, report bugs, and raise issues in the [Grafana Killercoda repository](https://github.com/grafana/killercoda). |
There was a problem hiding this comment.
| Provide feedback, report bugs, and raise issues in the [Grafana Killercoda repository](https://github.com/grafana/killercoda). | |
| Provide feedback, report bugs, and raise issues in the [Grafana Killercoda repository](https://github.com/grafana/killercoda). |
Extra CR/LF
Alloy includes a banner image at this point. There's no banner here? EDIT: I just saw the discussion around this. Nevermind.
Also, the Provide Feedback part is new compared to the Alloy version. Should I include this over in the Alloy tutorials?
There was a problem hiding this comment.
Seems like a good idea to update your own content, Clayton. @Jayclifford345 What do you think?
There was a problem hiding this comment.
Yeah, more than happy to have the banner removed and this section updated. I still think some form of icon or branding, later on, to differentiate it from a normal admonition makes users know this tutorial includes a sandbox from the initial glance.
Co-authored-by: Clayton Cornell <[email protected]>
All URLs are fully qualified so pre-processing isn't necessary.
|
Hi @knylander-grafana! Just FYI it looks like all of @clayton-cornell changes have been added as it looked already updated but apologies if I missed those. Huge thanks all for reviewing and getting this in. Its a big win! |
This is awesome! Let's go ahead and merge this. When you get the Killercoda side ready, then we'll merge the backport. |
Co-authored-by: Jack Baldry <[email protected]> Co-authored-by: Kim Nylander <[email protected]> Co-authored-by: Clayton Cornell <[email protected]> (cherry picked from commit bca38a2)
This PR adds the metadata required to sandbox the getting started guide of tempo. This will allow users to run the tutorial in an online VM. To test you can use this developer version: https://killercoda.com/grafana-labs-chaos-testing/course/tempo/quick-start
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX]