Skip to content

Commit 503a9fd

Browse files
authored
Update Quickstart with Jupyter Hub (#91)
* Rework getting started and next steps, add Colab placeholder * Rework Quickstart, add Colab info * Edits, tweaks * Fix typo
1 parent cbccb2d commit 503a9fd

25 files changed

+963
-310
lines changed

site/_quarto.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ website:
5757
- file: guide/tutorials.qmd
5858
contents:
5959
- guide/try-developer-framework-with-docker.qmd
60+
- guide/try-developer-framework-with-colab.qmd
6061
- text: "---"
6162
- file: guide/overview.qmd
6263
contents:

site/_site/guide/before-you-begin.html

Lines changed: 29 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,13 @@
189189
<li class="sidebar-item">
190190
<div class="sidebar-item-container">
191191
<a href="../guide/try-developer-framework-with-docker.html" class="sidebar-item-text sidebar-link">
192-
<span class="menu-text">Try the Developer Framework with Docker</span></a>
192+
<span class="menu-text">Try the Developer Framework with Docker Desktop</span></a>
193+
</div>
194+
</li>
195+
<li class="sidebar-item">
196+
<div class="sidebar-item-container">
197+
<a href="../guide/try-developer-framework-with-colab.html" class="sidebar-item-text sidebar-link">
198+
<span class="menu-text">Try the Developer Framework with Google Colaboratory</span></a>
193199
</div>
194200
</li>
195201
</ul>
@@ -250,6 +256,7 @@ <h2 id="toc-title">On this page</h2>
250256
<li><a href="#quickstart-requirements" id="toc-quickstart-requirements" class="nav-link" data-scroll-target="#quickstart-requirements">Quickstart requirements</a></li>
251257
<li><a href="#access-to-validminds-web-ui" id="toc-access-to-validminds-web-ui" class="nav-link" data-scroll-target="#access-to-validminds-web-ui">Access to Validmind’s Web UI</a></li>
252258
</ul></li>
259+
<li><a href="#whats-next" id="toc-whats-next" class="nav-link" data-scroll-target="#whats-next">What’s Next</a></li>
253260
</ul>
254261
</nav>
255262
</div>
@@ -273,7 +280,8 @@ <h1 class="title">Before you begin</h1>
273280

274281
</header>
275282

276-
<p>To try out ValidMind, you need to be a registered user on the ValidMind Platform.</p>
283+
<section id="prerequisites" class="level2">
284+
<h2 class="anchored" data-anchor-id="prerequisites">Prerequisites</h2>
277285
<div class="callout callout-style-default callout-tip callout-titled">
278286
<div class="callout-header d-flex align-content-center">
279287
<div class="callout-icon-container">
@@ -284,29 +292,38 @@ <h1 class="title">Before you begin</h1>
284292
</div>
285293
</div>
286294
<div class="callout-body-container callout-body">
287-
<p>If you are you interested in trying out ValidMind, please <a href="https://validmind.com/demo">contact us</a>.</p>
295+
<p><a href="https://validmind.com/demo">Request a trial</a> to try out ValidMind for free.</p>
288296
</div>
289297
</div>
290-
<section id="prerequisites" class="level2">
291-
<h2 class="anchored" data-anchor-id="prerequisites">Prerequisites</h2>
292-
<p>To connect ValidMind’s Developer Framework to the ValidMind platform and to access the ValidMind platform User Interface (Web UI), you must be able to access our domain - <code>validmind.ai</code> . If necessary, ask a network administrator to add this domain to your company’s firewall allowlist (whitelist).</p>
293-
<p>If your company has strict security requirements and requires you to connect via VPN or AWS PrivateLink, please contact your IT/InfoSec team. For additional help setting up a VPN or PrivateLink with ValidMind’s MRM platform please visit <a href="../guide/configure-aws-privatelink.html">configure AWS PrivateLink</a> or send an email to support@validmind.ai.</p>
298+
<p>To try out ValidMind, you need to be a registered user on the ValidMind Platform.</p>
299+
<p>To connect the ValidMind Developer Framework to the ValidMind Platform and to access the web user interface, you must be able to access our domains:</p>
300+
<ul>
301+
<li>validmind.ai</li>
302+
<li>validmind.com</li>
303+
</ul>
304+
<p>If necessary, ask a network administrator to add these domains to your firewall allowlist (whitelist).</p>
305+
<p>If your company has strict security requirements and requires you to connect via VPN or AWS PrivateLink, please contact your IT/InfoSec team. For additional help setting up a VPN or PrivateLink with ValidMind’s MRM platform please visit <a href="../guide/configure-aws-privatelink.html">configure AWS PrivateLink</a> or send an email to <a href="mailto:support@validmind.ai" class="email">support@validmind.ai</a>.</p>
294306
<section id="quickstart-requirements" class="level3">
295307
<h3 class="anchored" data-anchor-id="quickstart-requirements">Quickstart requirements</h3>
296-
<p>To follow the Quickstart, you need ONE of the following:</p>
308+
<p>To follow the Quickstart, you need access to ONE of the following:</p>
297309
<ul>
298-
<li>Access to <a href="https://colab.research.google.com/">Google Colaboratory (Colab)</a> where you can run our sample notebooks for free.</li>
299-
<li>Docker Desktop to <a href="../guide/try-developer-framework-with-docker.html">try the Developer Framework</a> with our Validmind Docker image.</li>
300-
<li>To run our sample Jupyter notebooks locally, your developer environment must support Python 3.8+.</li>
310+
<li><a href="../guide/quickstart.html">Jupyter Hub</a> (recommended)</li>
311+
<li><a href="../guide/try-developer-framework-with-colab.html">Google Colaboratory (Colab)</a></li>
312+
<li><a href="../guide/try-developer-framework-with-docker.html">Docker Desktop</a></li>
301313
</ul>
314+
<p>To run our sample Jupyter notebooks locally, your developer environment must support Python 3.8+.</p>
302315
<!--- If you download the sample notebooks from Colab, [sample Jupyter notebooks](jupyter-notebooks.qmd), for use To use ourlocally requires Python 3.8+. --->
303316
</section>
304317
<section id="access-to-validminds-web-ui" class="level3">
305318
<h3 class="anchored" data-anchor-id="access-to-validminds-web-ui">Access to Validmind’s Web UI</h3>
306319
<p>You need to be able to access our ValidMind Web UI from a modern browser such as Microsoft Edge, Google Chrome, Apple Safari, or Mozilla Firefox.</p>
320+
</section>
321+
</section>
322+
<section id="whats-next" class="level2">
323+
<h2 class="anchored" data-anchor-id="whats-next">What’s Next</h2>
324+
<p>Continue with <a href="../guide/explore-validmind.html">Explore ValidMind</a> in the Quickstart.</p>
307325

308326

309-
</section>
310327
</section>
311328

312329
</main> <!-- /main -->

site/_site/guide/editions-and-features.html

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,13 @@
191191
<li class="sidebar-item">
192192
<div class="sidebar-item-container">
193193
<a href="../guide/try-developer-framework-with-docker.html" class="sidebar-item-text sidebar-link">
194-
<span class="menu-text">Try the Developer Framework with Docker</span></a>
194+
<span class="menu-text">Try the Developer Framework with Docker Desktop</span></a>
195+
</div>
196+
</li>
197+
<li class="sidebar-item">
198+
<div class="sidebar-item-container">
199+
<a href="../guide/try-developer-framework-with-colab.html" class="sidebar-item-text sidebar-link">
200+
<span class="menu-text">Try the Developer Framework with Google Colaboratory</span></a>
195201
</div>
196202
</li>
197203
</ul>

0 commit comments

Comments
 (0)