Cloud Native PostgreSQL Operator live quickstart

[josh-heyer]

What's New?

A live (in-browser) demonstration of installation, configuration and deployment - essentially the combined contents of the CNP Quickstart, Install and Comdms pages.

This doesn't even get into the good stuff yet, but we gotta start somewhere - and I think a demo that takes literally 5 minutes to work through and leaves you with a 3-node cluster running ain't too bad for whetting the appetite!

View the demo here: https://edb-docs-adv-feature-jo-ukdchu.herokuapp.com/kubernetes/cloud_native_postgresql/interactive/installation_and_deployment/

What Changed?

This creates a section for interactive content that will be merged into the CNP docs during import. Lacking a more entertaining idea, I created the path merge_sources/kubernetes/cloud_native_postgresql and modified the import script to merge the contents of this path with the transformed documentation from the CNP repo (source_cloud_native_operator.py - see sync instructions for details).

I also modified that import script to add the "interactive" directory to the navigation, and a blurb highlighting the existence of a demo as the 2nd paragraph in quickstart.mdx. This is... somewhat fragile, but I don't care to over-engineer this part until / unless it becomes necessary - and right now, this is all that's being merged!

View the modified Quickstart page here: https://edb-docs-adv-feature-jo-ukdchu.herokuapp.com/kubernetes/cloud_native_postgresql/quickstart/ (and note the addition of an "Interactive Demos" section to the side nav)

Checklist

Content

• This PR adds new content
• This PR changes existing content
• This PR removes existing content

[josh-heyer]

@gsong could you take a look at this and suggest a better organization (one that would allow clean merging with future imports from the CNP repo)?

I approached this draft by moving Quickstart into its own subdirectory, with minor modifications to paths and the addition of a link to the demo; that looks clean enough I think, but is probably a bear to try to automate. Some initial ideas:

• Create separate subdirectory for demo(s) that would be ignored by CNP pulls (cross-linking might get awkward)
• Transfer ownership of Quickstart to this repo (again, would have to work out how linking would work)
• Transformation of Quickstart on import (more complicated import, but could allow CNP to continue to be autonomous)
• ???

[gsong]

At first blush, here's my thought:

• Host the additional content in a separate directory of this repo that's ignored by Gatsby.
• Upon import / update of external content source, the import process:
  • Copies the additional content into the content-proper area
  • In-place modifies the upstream files to reference the additional content

The in-place modification could be tricky but do-able, especially if we can inject some kind of comment place-holder upstream. We can choose to inject our custom snippet which links to new content at any stage of the import process.

[josh-heyer]

Eh, @gsong - I've mostly taken your suggestion and applied it - seems reasonable, only potential pitfall is editing stuff in the wrong place.

Have a look?

[josh-heyer]

@cero-miedo could you take a look at the blurb at the start of the Quickstart page here: https://edb-docs-adv-feature-jo-ukdchu.herokuapp.com/kubernetes/cloud_native_postgresql/quickstart/ (the admonition titled, "Live demonstration") and let me know your thoughts? Not sure it needs anything TBH, but might tie into the work you've been doing with Katacoda iconography elsewhere.

[josh-heyer]

@gbartolini I think you or someone from your team might be interested in looking over the demo I'm adding here, make sure I'm not misrepresenting anything in your work! Direct link: https://edb-docs-adv-feature-jo-ukdchu.herokuapp.com/kubernetes/cloud_native_postgresql/interactive/installation_and_deployment/

[pipetogrep]

I've merged in Evan's feature branch which allows us to signal that content is interactive.

Link from homepage

Header style added for Katacoda enriched content

• Button copy has also been renamed. Confusingly, we had called out "Interactive Tutorials" in the button, but referred to them as "Demos" around the site. Converging on Demo.

I've marked this as work in progress as I don't like the behaviour in the menu tree:

We can mark the parent as containing Demos, but it looks off when opened:

There are no interactive elements in the parent, and it looks clumsy stacking the badges.

[josh-heyer]

Yeah, the sidebar thing is... awkward. Also means the text of the top-level item is "Interactive DemosDemos" (lack of space there is also a problem for other titles with this badge).

[josh-heyer]

Gabriele gives approval for this; just need @cero-miedo to work out the design issues. Suggestions:

• Remove sidenav badges for now; too intrusive. We'll need to sit down and grind out a design there.
• Add specialized look for admonition

Robert's call - he'll own this from now until merge (I'm out next week but ping me if there are any questions)