Normalise parts of the guides to be included

[MshBidb]

I noticed when going to add a new guide that the same content is reused quite a bit, and some of it was slightly different (which I don't think was intentional).

This PR is an attempt to form some normality between the guides by including common segments.

I was not 100% sure where to put the reused segments, but feel assets/common/ is appropriate.

There is one issue I noticed, which is around the footnote for the LC connector documentation on the Hub 5x; but since this segment is only used on a single page, it's probably okay to deal with that later when it's reused.

[up-n-atom]

We're already using the snippets extension so there is no reason to add another hard dependency with the includes plugin mkdocs-include-markdown-plugin

https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#snippets

https://facelessuser.github.io/pymdown-extensions/extensions/snippets/

It has the ability to embed sections so we could just create a monolithic template.md and import the specific sections.

I'd also prefer the frontmatter to simply be ont for the macro.

Also there is already a shared asset folder in the posts directory /docs/posts/shared-assets

[MshBidb]

I have addressed the comments.

The new template.md file is created as requested. It requires some frontmatter content else mkdocs will fail to build (I guess we could also rename the file extension).

Now the bigger issue is that the ont from the including files frontmatter will not expand. But I think it may be okay to just remove that entirely?

[up-n-atom]

The macro plugin in requirements.txt went missing. Could that be the reason if you're rebuilding the env from scratch?

[MshBidb]

That was intentionally removed, but doesn't help even if it's re-enabled. It seems that the prohibitive part of this setup is when we include specific sections.

Variables would expand correctly with the following, but we lose the "monolith" include that you're after.

{% include "posts/shared-assets/template.md" %}

---

This is likely solveable if you don't mind a bit of Python being included? which is possible using the macros plugin

[up-n-atom]

We had that before. I pretty much want to keep it as vanilla as possible, just easier to reword.

[up-n-atom]

lost "the 8311 community firmware is recommended..."

[MshBidb]

Good catch, fixed by a384997 and I've double checked all the others against main

[MshBidb]

We had that before

I think there's a misunderstanding here. macros was added by 0be1aaf and subsequently removed by c558eeb. It's is not a part of main.

I pretty much want to keep it as vanilla as possible

Understood, updated the PR.