Skip to content

Update Quickstart with Jupyter Hub #91

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Jun 6, 2023
Merged

Update Quickstart with Jupyter Hub #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b0281e6
Rework getting started and next steps, add Colab placeholder
nrichers Jun 5, 2023
61ca19a
Rework Quickstart, add Colab info
nrichers Jun 6, 2023
880da4b
Edits, tweaks
nrichers Jun 6, 2023
7ee0f39
Fix typo
nrichers Jun 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions site/_quarto.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ website:
- file: guide/tutorials.qmd
contents:
- guide/try-developer-framework-with-docker.qmd
- guide/try-developer-framework-with-colab.qmd
- text: "---"
- file: guide/overview.qmd
contents:
Expand Down
41 changes: 29 additions & 12 deletions site/_site/guide/before-you-begin.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,13 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/try-developer-framework-with-docker.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Try the Developer Framework with Docker</span></a>
<span class="menu-text">Try the Developer Framework with Docker Desktop</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/try-developer-framework-with-colab.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Try the Developer Framework with Google Colaboratory</span></a>
</div>
</li>
</ul>
Expand Down Expand Up @@ -250,6 +256,7 @@ <h2 id="toc-title">On this page</h2>
<li><a href="#quickstart-requirements" id="toc-quickstart-requirements" class="nav-link" data-scroll-target="#quickstart-requirements">Quickstart requirements</a></li>
<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>
</ul></li>
<li><a href="#whats-next" id="toc-whats-next" class="nav-link" data-scroll-target="#whats-next">What’s Next</a></li>
</ul>
</nav>
</div>
Expand All @@ -273,7 +280,8 @@ <h1 class="title">Before you begin</h1>

</header>

<p>To try out ValidMind, you need to be a registered user on the ValidMind Platform.</p>
<section id="prerequisites" class="level2">
<h2 class="anchored" data-anchor-id="prerequisites">Prerequisites</h2>
<div class="callout callout-style-default callout-tip callout-titled">
<div class="callout-header d-flex align-content-center">
<div class="callout-icon-container">
Expand All @@ -284,29 +292,38 @@ <h1 class="title">Before you begin</h1>
</div>
</div>
<div class="callout-body-container callout-body">
<p>If you are you interested in trying out ValidMind, please <a href="https://validmind.com/demo">contact us</a>.</p>
<p><a href="https://validmind.com/demo">Request a trial</a> to try out ValidMind for free.</p>
</div>
</div>
<section id="prerequisites" class="level2">
<h2 class="anchored" data-anchor-id="prerequisites">Prerequisites</h2>
<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>
<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>
<p>To try out ValidMind, you need to be a registered user on the ValidMind Platform.</p>
<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>
<ul>
<li>validmind.ai</li>
<li>validmind.com</li>
</ul>
<p>If necessary, ask a network administrator to add these domains to your firewall allowlist (whitelist).</p>
<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>
<section id="quickstart-requirements" class="level3">
<h3 class="anchored" data-anchor-id="quickstart-requirements">Quickstart requirements</h3>
<p>To follow the Quickstart, you need ONE of the following:</p>
<p>To follow the Quickstart, you need access to ONE of the following:</p>
<ul>
<li>Access to <a href="https://colab.research.google.com/">Google Colaboratory (Colab)</a> where you can run our sample notebooks for free.</li>
<li>Docker Desktop to <a href="../guide/try-developer-framework-with-docker.html">try the Developer Framework</a> with our Validmind Docker image.</li>
<li>To run our sample Jupyter notebooks locally, your developer environment must support Python 3.8+.</li>
<li><a href="../guide/quickstart.html">Jupyter Hub</a> (recommended)</li>
<li><a href="../guide/try-developer-framework-with-colab.html">Google Colaboratory (Colab)</a></li>
<li><a href="../guide/try-developer-framework-with-docker.html">Docker Desktop</a></li>
</ul>
<p>To run our sample Jupyter notebooks locally, your developer environment must support Python 3.8+.</p>
<!--- If you download the sample notebooks from Colab, [sample Jupyter notebooks](jupyter-notebooks.qmd), for use To use ourlocally requires Python 3.8+. --->
</section>
<section id="access-to-validminds-web-ui" class="level3">
<h3 class="anchored" data-anchor-id="access-to-validminds-web-ui">Access to Validmind’s Web UI</h3>
<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>
</section>
</section>
<section id="whats-next" class="level2">
<h2 class="anchored" data-anchor-id="whats-next">What’s Next</h2>
<p>Continue with <a href="../guide/explore-validmind.html">Explore ValidMind</a> in the Quickstart.</p>


</section>
</section>

</main> <!-- /main -->
Expand Down
8 changes: 7 additions & 1 deletion site/_site/guide/editions-and-features.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,13 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/try-developer-framework-with-docker.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Try the Developer Framework with Docker</span></a>
<span class="menu-text">Try the Developer Framework with Docker Desktop</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/try-developer-framework-with-colab.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Try the Developer Framework with Google Colaboratory</span></a>
</div>
</li>
</ul>
Expand Down
Loading