Skip to content

Mock up Quickstart revamp #95

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

Merged
merged 19 commits into from
Jun 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ The ValidMind Platform is the central place to:

Next, let's learn how to create your own documentation project. You can use this project to upload tests and documentation and then add that to the Quickstart notebook you looked at earlier.

1. Navigate to the landing page by clicking on the ValidMind logo or if you have to, [Log in to the ValidMind UI]({{< var vm_ui >}}).
1. Navigate to the landing page by clicking on the ValidMind logo or [Log in to the ValidMind UI]({{< var vm_ui >}}).

2. From the left sidebar, select **Documentation Projects** and on the page that opens, click the **Create new Project** button at top right of the screen.

Expand Down
19 changes: 11 additions & 8 deletions site/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,18 +46,21 @@ website:

- title: "Get Started"
contents:
- guide/get-started.qmd
- text: "Get Started"
file: guide/get-started.qmd
- text: "---"
- file: guide/quickstart.qmd
contents:
- guide/before-you-begin.qmd
- guide/explore-validmind.qmd
- guide/next-steps.qmd
- text: "---"
- file: guide/tutorials.qmd
- text: "Quickstarts"
file: guide/quickstart.qmd
- text: "Explore the Developer Framework — 10 minutes"
contents:
- guide/try-developer-framework-with-jupyterhub.qmd
- guide/try-developer-framework-with-docker.qmd
- guide/try-developer-framework-with-colab.qmd
- text: "Explore the Platform UI — 15 minutes"
contents:
- guide/explore-example-documentation-project.qmd
- guide/create-your-first-documentation-project.qmd
- guide/upload-to-documentation-project.qmd
- text: "---"
- file: guide/overview.qmd
contents:
Expand Down
144 changes: 6 additions & 138 deletions site/_site/guide/before-you-begin.html
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
<link rel="stylesheet" href="../styles.css">
</head>

<body class="nav-sidebar docked nav-fixed">
<body class="nav-fixed">

<div id="quarto-search-results"></div>
<header id="quarto-header" class="headroom fixed-top">
Expand All @@ -90,7 +90,7 @@
<div class="collapse navbar-collapse" id="navbarCollapse">
<ul class="navbar-nav navbar-nav-scroll me-auto">
<li class="nav-item">
<a class="nav-link active" href="../guide/get-started.html" rel="" target="" aria-current="page">
<a class="nav-link" href="../guide/get-started.html" rel="" target="">
<span class="menu-text">Get Started</span></a>
</li>
<li class="nav-item">
Expand All @@ -115,142 +115,10 @@
</div> <!-- /navcollapse -->
</div> <!-- /container-fluid -->
</nav>
<nav class="quarto-secondary-nav">
<div class="container-fluid d-flex">
<button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
<i class="bi bi-layout-text-sidebar-reverse"></i>
</button>
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../guide/quickstart.html">Quickstart — 20 mins</a></li><li class="breadcrumb-item"><a href="../guide/before-you-begin.html">Before you begin</a></li></ol></nav>
<a class="flex-grow-1" role="button" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
</a>
<button type="button" class="btn quarto-search-button" aria-label="Search" onclick="window.quartoOpenSearch();">
<i class="bi bi-search"></i>
</button>
</div>
</nav>
</header>
<!-- content -->
<div id="quarto-content" class="quarto-container page-columns page-rows-contents page-layout-article page-navbar">
<!-- sidebar -->
<nav id="quarto-sidebar" class="sidebar collapse collapse-horizontal sidebar-navigation docked overflow-auto">
<div class="mt-2 flex-shrink-0 align-items-center">
<div class="sidebar-search">
<div id="quarto-search" class="" title="Search"></div>
</div>
</div>
<div class="sidebar-menu-container">
<ul class="list-unstyled mt-1">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/get-started.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Get started</span></a>
</div>
</li>
<li class="px-0"><hr class="sidebar-divider hi "></li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a href="../guide/quickstart.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Quickstart — 20 mins</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/before-you-begin.html" class="sidebar-item-text sidebar-link active">
<span class="menu-text">Before you begin</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/explore-validmind.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Explore ValidMind</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/next-steps.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Next steps</span></a>
</div>
</li>
</ul>
</li>
<li class="px-0"><hr class="sidebar-divider hi "></li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a href="../guide/tutorials.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Tutorials</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="" class="collapse list-unstyled sidebar-section depth1 show">
<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 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>
</li>
<li class="px-0"><hr class="sidebar-divider hi "></li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a href="../guide/overview.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">ValidMind overview</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/editions-and-features.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Editions and features</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/license-agreement.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">License agreement</span></a>
</div>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#" aria-expanded="true">
<span class="menu-text">Releases</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="" class="collapse list-unstyled sidebar-section depth2 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/release-notes-2023-jun-22.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">June 22, 2023</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/release-notes-2023-may-30.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">May 30, 2023</span></a>
</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</nav>
<div id="quarto-sidebar-glass" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass"></div>
<!-- margin-sidebar -->
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="2">
Expand All @@ -260,7 +128,7 @@ <h2 id="toc-title">On this page</h2>
<li><a href="#prerequisites" id="toc-prerequisites" class="nav-link active" data-scroll-target="#prerequisites">Prerequisites</a>
<ul class="collapse">
<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>
<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>
Expand Down Expand Up @@ -313,21 +181,21 @@ <h2 class="anchored" data-anchor-id="prerequisites">Prerequisites</h2>
<h3 class="anchored" data-anchor-id="quickstart-requirements">Quickstart requirements</h3>
<p>To follow the Quickstart, you need access to ONE of the following:</p>
<ul>
<li><a href="../guide/quickstart.html">Jupyter Hub</a> (recommended)</li>
<li><a href="../guide/try-developer-framework-with-jupyterhub.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>
<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>
<p>Continue with Explore the Developer Framework. We recommend using <a href="../guide/try-developer-framework-with-jupyterhub.html">Jupyter Hub</a>.</p>


</section>
Expand Down
Binary file added site/_site/guide/client-integration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 1 addition & 2 deletions site/_site/guide/create-documentation-project.html
Original file line number Diff line number Diff line change
Expand Up @@ -370,8 +370,7 @@ <h2 class="anchored" data-anchor-id="steps">Steps</h2>
</div>
</div>
</div></div><p>ValidMind has now created an empty documentation project associated with the model. You can access this project from the UI on the <strong>Documentation Projects</strong> page or by navigating to the relevant model details page in the <strong>Model Inventory</strong> page.</p>
<!--- TO DO I believe this will move, so we need to revisit this --->
<ol start="4" type="1">
<ol start="5" type="1">
<li><p>Locating the project identifier, API key and secret:</p>
<p>On the <strong>Client Integration</strong> page of the newly created project, you can find the initialization code that enables the client library to associate documentation and tests with the appropriate project. The initialization code configures the following arguments:</p></li>
</ol>
Expand Down
Binary file added site/_site/guide/create-project.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading