docs: fix markdown code blocks#163
Conversation
✅ Deploy Preview for frolicking-manatee-96c0c8 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
matdibu
force-pushed
the
fix-docs-markdown-blocks
branch
from
56e9c2c to
0952c9f
Compare
|
|
||
| Ensure the pod was created successfully (in running state): | ||
| ```bash | ||
| kubectl get pods |
There was a problem hiding this comment.
For me easy copy&paste is far more usable than preety formatting in this case (simplier to dummy copy and run it) - @fitzthum what's your Opinion ?
There was a problem hiding this comment.
the only reason behind this change was to bring it in line with other places where a command is shown together with its output
There was a problem hiding this comment.
Ideally it would be nice to copy ready to use command without additional "$" and console output - faster - quicker - less error prone. We need alignments there but this particular for me personally is kind of regression
There was a problem hiding this comment.
I'll revert this bit, no problem
we can follow up with another PR to address this
There was a problem hiding this comment.
Yeah, maybe for single commands we should try to use bash and save the $s for multi-line commands. We can adjust in later PR.
matdibu
force-pushed
the
fix-docs-markdown-blocks
branch
from
0952c9f to
9df6c6b
Compare
| some allowed_image in policy_data.allowed_images | ||
| storage.source == allowed_image | ||
| } | ||
| some allowed_image in policy_data.allowed_images |
There was a problem hiding this comment.
Probably should be
| some allowed_image in policy_data.allowed_images | |
| some allowed_image in policy_data.allowed_images |
|
Thanks @matdibu for aligning code blocks one step closer to seamless experience in docs ^^ |
Some markdown code blocks were rendering incorrectly: - code blocks without an explicit language were sometimes interpreted as math formulas - rego blocks were not labelled or were labelled as opa - yaml's had invalid whitespace and syntax - bash snippets that echo to a file were marked as being that file's format - mix-ups between shell scripts (```bash) and console sessions (```console) Signed-off-by: Matei Dibu <contact@mateidibu.dev>
matdibu
force-pushed
the
fix-docs-markdown-blocks
branch
from
9df6c6b to
21deba5
Compare
dcmiddle
left a comment
dcmiddle
left a comment
There was a problem hiding this comment.
Thanks for the fixes and really nice cover sheet!
4 participants
Examples of issues fixed: