Authoring of triple-backtick codblocks prevents rendering in Jekyll/Liquid about docs-csm HOT 5 CLOSED

Appreciate the feedback. We're looking into this now.

from docs-csm.

Thanks for creating the issue and for the follow-up PRs. This is a good change and can merge once the PRs are fixed up.

from docs-csm.

Just following up on this, now the heat is off a bit here.

I gave up trying to re-base and just cloned the latest main branch
and have just pulled it up to date, so as to be at commit

3098cced5a0 (upstream/main, upstream/HEAD, main) CASMINST-4695: More linting

The good news:

I have only found one instance of triple-backticks code-blocks not having
been coded correctly.

That's at line 539 in this file,

./operations/kubernetes/Troubleshoot_Postgres_Database.md

where there's a block closed with a double tick, not a triple.

Some other news:

There's one place where the basic script I have been running to check, for
unclosed triple-backticks running into other Markdown commands, trips up,
and that's because of the use of a double-hash inside a code block, eg

## This example assumes the csm-1.0.0 release is currently running and the csm-1.0.0.tar.gz has been pulled down under /root
ncn# cd /root
ncn# tar -xzf csm-1.0.0.tar.gz

where the double-hash is the 2nd-level heading markup in Markdown.

FWIW, that's at line 73 in

./operations/CSM_product_management/Post_Install_Customizations.md

and it's worth noting that the comment pretty much echoes the text in the
paragraph above the code-block anyway.

Now yes, I could try and write a better parser, but do you (or perhaps: do the docs) need
to have comments inside the code-blocks anyway?

It doesn't look, given the prompts, as though such code-blocks are meant to
be cut and pasted directly, so do you gain anything from commenting inside
them?

More of an observation though, that one.

from docs-csm.

Just in case anyone is interested, the "tooling harness" I have been using
to render the sources in Jekyll is now available as a branch stored at my
fork/clone of the vanilla sources

https://github.com/pawsey-kbuckley/docs-csm/tree/format-with-jekyll

As of the main branch's

commit 0da68dd

it seems rto be rendering, although i can't claim to have viewed every page!

from docs-csm.

Closing this issue given #1719, #1729, and #1728 have merged.

from docs-csm.