Skip to content

Commit

Permalink
[GH-15680] Adding installation disclaimer in documentation (#15681)
Browse files Browse the repository at this point in the history
* ht/adding disclaimer in docs

* ht/added flow & download page

* ht/updated download page

* ht/added security documentation section

* ht/user guide updates

* ht/uniformity

* ht/added additional note to welcome page

* callouts

* ht/banner color switch

* ht/rename callout

---------

Co-authored-by: Jeff Fohl <[email protected]>
  • Loading branch information
hannah-tillman and jefffohl authored Aug 16, 2023
1 parent 48abf3a commit 9b0a044
Show file tree
Hide file tree
Showing 7 changed files with 69 additions and 3 deletions.
35 changes: 35 additions & 0 deletions h2o-dist/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,35 @@
.pre {
white-space: pre;
}

.callout {
padding: 15px;
background-color: #eee;
color: #000;
position: relative;
border-left: solid 4px #999;
}

.callout--info {
padding-left: 55px;
border-left-color: #00a0cc;
background-color: rgb(0 150 200 / 0.15);
}

.callout--info::before {
content: '⚠';
font-size: 32px;
font-weight: 200;
font-family: 'Open Sans', sans-serif, system-ui;
color: #00a0cc;
position: absolute;
top: 4px;
left: 10px;
}

.callout--info a {
color: #00a0cc;
}

</style>
<script>
Expand Down Expand Up @@ -562,6 +591,7 @@ <h1><span>H<sub>2</sub>O</span></h1>
</div>
<h2>Get started with H<sub>2</sub>O in 3 easy steps</h2>
<p>1. Download H<sub>2</sub>O. This is a zip file that contains everything you need to get started.</p>
<p class="callout callout--info">By default, this setup is open. If you want to secure your installation, follow the <a href="https://docs.h2o.ai/h2o/latest-stable/h2o-docs/security.html" target="_blank">Security Guidelines.</a></p>
<p>2. From your terminal, run:</p>

<button class="btn copy_button" id="btnCopy1" data-clipboard-target='#to_copy1'></button>
Expand Down Expand Up @@ -589,6 +619,7 @@ <h2>Use H<sub>2</sub>O directly from Python</h2>
<p class="terminal" id="to_copy12">
pip install matplotlib<br/>
</p>
<p class="callout callout--info">By default, this setup is open. If you want to secure your installation, follow the <a href="https://docs.h2o.ai/h2o/latest-stable/h2o-docs/security.html" target="_blank">Security Guidelines.</a></p>
<p>At the command line, copy and paste these commands one line at a time:</p>
<button class="btn copy_button" id="btnCopy2" data-clipboard-target='#to_copy2'></button>
<p class="terminal" id="to_copy2">
Expand All @@ -608,6 +639,8 @@ <h2>Conda Installation</h2>
<div id="quickstart-r" style="display:none">
<h2>Use H<sub>2</sub>O directly from R</h2>

<p class="callout callout--info">By default, this setup is open. If you want to secure your installation, follow the <a href="https://docs.h2o.ai/h2o/latest-stable/h2o-docs/security.html" target="_blank">Security Guidelines.</a></p>

<p>Copy and paste these commands into R one line at a time:</p>
<button class="btn copy_button" id="btnCopy3" data-clipboard-target='#to_copy3'></button>
<p class="terminal" id="to_copy3"data-clipboard-target='to_copy3'>
Expand Down Expand Up @@ -817,6 +850,8 @@ <h2>User Documentation</h2>
<div id="user_documentation"></div>
<h2>Developer Documentation</h2>
<div id="developer_documentation"></div>
<h2>Security Documentation</h2>
<p><a href="https://docs.h2o.ai/h2o/latest-stable/h2o-docs/security.html" target="_blank"> Security Guidelines</a></p>
<h2>Booklets</h2>
<div id="booklets"></div>
</div>
Expand Down
13 changes: 12 additions & 1 deletion h2o-docs/src/product/downloading.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ If you plan to exclusively use H2O's web GUI, `Flow <http://docs.h2o.ai/h2o/late

1. Click the ``Download H2O`` button on the `http://h2o-release.s3.amazonaws.com/h2o/latest_stable.html <http://h2o-release.s3.amazonaws.com/h2o/latest_stable.html>`__ page. This downloads a zip file that contains everything you need to get started.

.. note::

By default, this setup is open. Follow `security guidelines <security.html>`__ if you want to secure your installation.

2. From your terminal, unzip and start H2O as in the example below.

.. substitution-code-block:: bash
Expand All @@ -26,12 +30,15 @@ If you plan to exclusively use H2O's web GUI, `Flow <http://docs.h2o.ai/h2o/late

3. Point your browser to http://localhost:54321 to open up the H2O Flow web GUI.


Install in R
------------

Perform the following steps in R to install H2O. Copy and paste these commands one line at a time.

.. note::

By default, this setup is open. Follow `security guidelines <security.html>`__ if you want to secure your installation.

1. The following two commands remove any previously installed H2O packages for R.

.. code-block:: r
Expand Down Expand Up @@ -70,6 +77,10 @@ Alternatively you can install H2O’s R package from `CRAN <https://cran.r-proje
Install in Python
-----------------

.. note::

By default, this setup is open. Follow `security guidelines <security.html>`__ if you want to secure your installation.

Run the following commands in a Terminal window to install H2O for Python.

1. Install dependencies (prepending with ``sudo`` if needed):
Expand Down
5 changes: 4 additions & 1 deletion h2o-docs/src/product/flow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,10 @@ Download Flow
.. substitution-code-block:: bash

curl -o h2o.zip http://download.h2o.ai/versions/h2o-|version|.zip


.. note::

By default, this setup is open. Follow `security guidelines <security.html>`__ if you want to secure your installation.

2. Next in your terminal, enter the following command lines one at a time. The first line changes into your Downloads folder, the second line unzips your zipfile, the third line changes into your h2o-3-|version| folder, and the fourth line runs your jar file.

Expand Down
1 change: 1 addition & 0 deletions h2o-docs/src/product/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Additional Resources:
- See how are customers are using H2O at https://www.h2o.ai/customers/.
- Keep up to date with the latest H2O blogs at https://www.h2o.ai/blog/.
- Review projects, applications, research papers, tutorials, courses, and books that use H2O at https://github.com/h2oai/awesome-h2o.
- Learn about securing your installation by following our `security guidelines <security.html>`__.

.. toctree::
:maxdepth: 2
Expand Down
4 changes: 4 additions & 0 deletions h2o-docs/src/product/quick-start-videos.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
Quick Start Videos
==================

.. note::

By default, this setup is open. Follow `security guidelines <security.html>`__ if you want to secure your installation.


H2O Quick Start with Flow
-------------------------
Expand Down
2 changes: 1 addition & 1 deletion h2o-docs/src/product/starting-h2o.rst
Original file line number Diff line number Diff line change
Expand Up @@ -404,7 +404,7 @@ The flatfile contains a list of nodes in the form ``IP:PORT`` that are going to
Web Server
^^^^^^^^^^

The web server IP is auto-configured in the same way as internal communication IP, nevertheless the created socket listens on all available interfaces. A specific API can be specified with the ``-web_ip`` option.
By default, the web server IP is auto-configured in the same way as internal communication IP, nevertheless the created socket listens on all available interfaces. A specific IP can be specified with the ``-web_ip`` option.

Options
'''''''
Expand Down
12 changes: 12 additions & 0 deletions h2o-docs/src/product/welcome.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,10 @@ learn more:

- `GitHub Help <https://help.github.com/>`_: The GitHub Help system is a useful resource for becoming familiar with Git.

.. note::

By default, this setup is open. Follow `security guidelines <security.html>`__ if you want to secure your installation.

Use Cases
~~~~~~~~~

Expand Down Expand Up @@ -165,6 +169,10 @@ At this point, determine whether you want to complete this quick start in either
Type 'q()' to quit R.
>

# By default, this setup is open.
# Follow our security guidelines (https://docs.h2o.ai/h2o/latest-stable/h2o-docs/security.html)
# if you want to secure your installation.

# Copy and paste the following commands in R to download dependency packages.
> pkgs <- c("methods", "statmod", "stats", "graphics", "RCurl", "jsonlite", "tools", "utils")
> for (pkg in pkgs) {if (! (pkg %in% rownames(installed.packages()))) { install.packages(pkg) }}
Expand Down Expand Up @@ -199,6 +207,10 @@ At this point, determine whether you want to complete this quick start in either

.. code-tab:: python

# By default, this setup is open.
# Follow our security guidelines (https://docs.h2o.ai/h2o/latest-stable/h2o-docs/security.html)
# if you want to secure your installation.

# Before starting Python, run the following commands to install dependencies.
# Prepend these commands with `sudo` only if necessary:
# h2o-3 user$ [sudo] pip install -U requests
Expand Down

0 comments on commit 9b0a044

Please sign in to comment.