Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GH-16182: Updating user guide page Welcome to reflect makersaurus guidelines [nocheck] #16183

Open
wants to merge 29 commits into
base: rel-3.46.0
Choose a base branch
from

Conversation

hannah-tillman
Copy link
Contributor

#16182

This PR is a large overhaul over the Welcome page structure. A while ago I was also tasked with making the Welcome page less overwhelming which is why this is a more in-depth update than any of the other pages will be.

  • Kept basic framework explanation and requirements all on initial welcome page
  • Gave all user-types their own pages (structured similar to the algorithms section)
    • Some pages (like Flow's and API's) are very small pages because of this
  • Broke up bulkier sections
  • Standardized headers
  • Improved link text and alt text
  • General fixes/adherence to style guide

Any feedback is super welcome! This is a bigger change than normal, but breaks down the information into more digestible chunks. Let me know your thoughts :)

maurever
maurever previously approved these changes Apr 29, 2024
Copy link
Contributor

@maurever maurever left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @hannah-tillman! I like the split into more pages by type of user.

I have only few notes.


To begin, download a copy of H2O from the `Downloads page <https://h2o.ai/resources/download/>`__.

1. Click H2O Open Source Platform or scroll down to the H2O section. Here you have access to the different ways to download H2O:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am surprised we called our product just H2O and not H2O-3. 🤔 I think it collides with the company name a little bit and can be confusing.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it might be because of how old the guide is. I can update to H2O-3 as I go through now, though, to be less confusing if we think that's best?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be great. But we should check it with @wendycwong and @mmalohlava. On our website, the product is also called H2O.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hannah-tillman : I check the resource page and h2o-3 is used to denote h2o opensource:

Screenshot 2024-05-22 at 11 25 58 AM

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, we either use H2O open source or just use H2O-3. I suggest using H2O-3 after setting H2O open source == H2O-3.

h2o-docs/src/product/getting-started/python-users.rst Outdated Show resolved Hide resolved
h2o-docs/src/product/getting-started/r-users.rst Outdated Show resolved Hide resolved
h2o-docs/src/product/getting-started/r-users.rst Outdated Show resolved Hide resolved
h2o-docs/src/product/welcome.rst Outdated Show resolved Hide resolved
h2o-docs/src/product/welcome.rst Outdated Show resolved Hide resolved
@valenad1 valenad1 linked an issue May 31, 2024 that may be closed by this pull request
several frm >from
note/admonition fixes
reorder hadoop example
several title lengthens
@hannah-tillman
Copy link
Contributor Author

@wendycwong I tested all the links again and they're still working on my end. I don't know why they aren't working for you :( Is anyone else having this issue?

wendycwong
wendycwong previously approved these changes Aug 19, 2024
wendycwong
wendycwong previously approved these changes Aug 21, 2024
@hannah-tillman hannah-tillman changed the title GH-16182: Updating user guide page Welcome to reflect makersaurus guidelines GH-16182: Updating user guide page Welcome to reflect makersaurus guidelines [nocheck] Oct 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Updating user guide - Welcome to adhere to makersaurus guidelines
4 participants