h2o-3 icon indicating copy to clipboard operation
h2o-3 copied to clipboard

PUBDEV-8632: Implement major release blogs into User Guide

Open hannah-tillman opened this issue 2 years ago • 1 comments

For: PUBDEV-8632

This is the first draft of implementing the major release blog into the User Guide.

The set up for this is slightly different from the blog we release on the site: it focuses on why this update was implemented (having practical use case possibilities would be esp nice) and includes how to use the update (a demo if one was made, or a code example). Less of the cool technical information, more of the practical "how-to" information.

I pushed the change log and this major release blog tab to the top of the index, so we can highlight all recent changes. At the bottom of the page, I linked to where all of our major release blogs can be found on the site to make them more accessible. I've included a little video to show how it currently looks.

Please let me know if you have any suggestions, questions, or if there are any updates you would like to see :)

https://user-images.githubusercontent.com/52463461/171468621-e97040c7-e6c5-4a2c-be5f-5758a6e44a67.mov

hannah-tillman avatar Jun 01 '22 17:06 hannah-tillman

This looks great @hannah-tillman . My suggestion of format for feature blogs:

Header (Title of the Feature)

  • One paragraph about what the feature is and why we added it
  • If applicable, picture or diagram of what the output would look like
  • Code Example for R and Python

Here is an example of what I'm thinking (from the Wave blog): Screen Shot 2022-06-01 at 1 46 52 PM

The small paragraph at the top describes what the feature is and why they added it. Then the code shows how to use it and the picture shows the output.

meganjkurka avatar Jun 01 '22 17:06 meganjkurka