Scaffolding plan for a JupyterHealth site

[colliand]

Capturing here a stub from the JupyterHealth Software Team to build a MyST website for the JupyterHealth project. @fperez will provide some scaffolding for us to move this forward....

[fperez]

I ran out of time to write things down, but I did a good brain dump with @ryanlovett in his office, so I trust him to take lead on this henceforth, and will trust his conclusions/suggested path forward.

[ryanlovett]

From what was discussed, the ideal is to:

• Have website content start as markdown so that anyone in the project can easily author new content or submit changes. Let's not author in HTML.
• Use one technology for all sites (if there are more than one) to reduce complexity.
• Put all content under one site.
• Have attractive "hero" sections on the front page and some set of landing pages.
• Try myst, and see where it takes us.

We may not be able to achieve all of this initially, but we'll give it a go.

[fperez]

Quick note - based on input from Ida and syncing with some presentations she will be giving, we should target having something live before May 16th.

If that means making more pragmatic choices on the tech (including using two separate tools, one for the landing/"living room" area and a separate one for the docs/"garage") for now, so be it. We can refine later with more time...

@ryanlovett - I didn't have this deadline in mind when we last talked, so this is an adjustment. We don't need anything super fancy, so if you find that we can get enough visuals for the "living room" as per the above, go for it. But if it looks like a rabbit hole at this stage, then let's pick up something more like those html5up templates that we can prettify in an afternoon and just link to our myst-based content using two repos, and we can revisit the landing area later.

[ryanlovett]

@fperez I can demo something early next week that shows what is possible right now.

In either case, we'll need landing page content and imagery. I'm guessing the images for "hero" content, banners, etc. will be harder to come by. Do you have a source in mind? I'm playing with filler right now.

[colliand]

Thanks @ryanlovett and @fperez. (FYI @jnywong @jmunroe as the work stream discussed here exemplifies some of the ongoing discussions within 2i2c re: content sharing...)

[maryamv]

Thanks @ryanlovett, @fperez, and @colliand! Before the decision was made to use MYST and Jupyter's internal ecosystem for website publishing, I had been experimenting with a Hugo-based solution on my local machine for our needs. While I'm not advocating for this to be our final choice, I thought it might be of interest given our situation now. I've pushed my preliminary work to our GitHub repository now for the team to review: https://jupyterhealth.github.io/

The content is in draft form, and the site's aesthetic is very much a work in progress - my goal was to get a feel for the potential layout and content presentation with this particular Hugo’s theme’s limitation. To @fperez point, this solution will link to our myst-based content using two repos.

Regardless of the platform we ultimately choose, we’ll need robust content and imagery. To that end, I've put my initial content on a google doc so we can collectively rewrite, edit, comment as it needs tons of inputs.

[ryanlovett]

Thanks @maryamv ! I'll put your content into a myst-based analog so we can compare.

[fperez]

@maryamv - huge thanks for that prototype, I love it! I think it's a great start and gives us something to build on quickly. Whichever toolchain we pick, this is very useful work already.

I personally would prefer if we have a consistent MyST-based solution in the long run, for the reasons summarized above by @ryanlovett, but it's 💯 OK if we start with a Hugo-based one for the time being for this front-facing content.

Let's see what @ryanlovett finds with a small amount of effort to explore our options, and we can make a decision soon. Thanks all!

[ryanlovett]

@fperez , @maryamv I've mocked up @maryamv 's Hugo-based site in two MyST sites at https://jupyterhealth.github.io/myst-site-article/ and https://jupyterhealth.github.io/myst-site-book/. Neither look as nice as the Hugo site IMO.

• The only theme that can support full-width elements is the article theme and it can only do it for the banner graphic.
• The article theme treats subpages as "supporting documents" in the navigation, which is not what we want.
• The side navigation inhibits the desired styling.
• I could colorize and center justify the headings as in the Hugo site, but it would cause the navigation links to also be orange and centered.
• I think the custom style (stripped down nav) at pages like https://mystmd.org/overview is accomplished through use of an embedded theme.

[ryanlovett]

I'm happy to keep iterating on the MyST sites, even if the Hugo site or some other is used as the landing page in mid-May.

[ryanlovett]

Rowan has also graciously offered:

if this is a near-term request that needs some love to one of the templates, let us know and I can see if we can help fix things up for you.

[ryanlovett]

I think the book version, https://jupyterhealth.github.io/myst-site-book/, is now in fairly good shape. It is much closer to the Hugo version, but is missing:

• links that look like buttons
• colored headings
• a banner background image
• a footer

There's a bug with site nav triggering an application error which I'll file in the morning.