*: content revamp

[rexagod]

These changes mostly entail:

• workflow to check for new theme releases,
• improved synchronization logic,
• better reference defintions in generated content,
• serve minified JS,
• higher degree of automation.

Fixes: https://github.com/prometheus-operator/prometheus-operator/issues/6046

[rexagod]

I'd like to propose a standard that all documentation in the dependent repositories adhere to, in order to improve the overall readability of the website. A couple of concerns I noticed were:

• Missing header sections, which will cause Hugo to crash, if they are hyperlinked within the served manifests. Currently the script prepends a title: XXXX (foo-bar.md becomes ---\ntitle: Foo Bar\n---\n) to documents lacking such a header section.
• HTML and short-code are used interchangeably for inserting web elements into the documents, and there seems to be no clear choice between the two.
• Redundant prepended path in links (bar.md is specified as foo/bar.md, when the former would work just the same). Introducing a lint rule for this would ensure the path translation of the pages w.r.t. serving content (content/docs/foo/bar.md is served as localhost:XXXX/docs/foo/bar/ and needs to be sed-ed as such before serving) is consistent throughout the text.

These are the ones I can think of right now from the top of my mind, but in general, it could prove beneficial to adhere to a documentation standard (such as k/enhancements does for KEPs) and even introducing a lint rule to automate validating all that.

[rexagod]

@simonpasquier raised a concern around outdated content that we'd be better off ignoring when compiling the website. I believe this could be addressed when writing the document and including something like website-ignore: true within the header.

[simonpasquier]

Thanks for starting this! From my POV, I'd like first that we clean up the existing MarkDown files (in terms of consistency, relevance, out-dated information, ....) as well as brainstorm on how we want the content to be organized.

[rexagod]

Sounds good, Simon. I'll get started on that front. :)

[simonpasquier]

Having said that, some of the proposed changes might already be good to go (like Makefile updates).

[slashpai]

@AshwinSriram11 since you are already working on website see if this helps