Skip to content

User guide updates for adding content blocks #109

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 9 commits into from
Jul 23, 2023
Merged

User guide updates for adding content blocks #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d4b52f8
docs page for adding content block
p-m-s-f Jun 29, 2023
8b4976d
edited step 3 & added to left navbar
p-m-s-f Jul 5, 2023
8810175
Fix merge conflicts
nrichers Jul 19, 2023
64e6a6e
Expand topic with more info, add animated GIF
nrichers Jul 20, 2023
ce1532f
Remove markdowntest file
nrichers Jul 20, 2023
1f69717
Remove comment from source
nrichers Jul 20, 2023
733a32f
Add steps for test-driven content blocks, interim GIF update
nrichers Jul 23, 2023
c46106e
Text edit
nrichers Jul 23, 2023
7f08dd1
Text edit
nrichers Jul 23, 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 @@ -100,6 +100,7 @@ website:
- guide/edit-model-inventory-fields.qmd
- guide/create-documentation-project.qmd
- guide/document-models-with-framework.qmd
- guide/add-content-blocks.qmd
- guide/load-credentials-to-env-file.qmd
- guide/document-models-with-ui.qmd
- guide/view-all-test-plans.qmd
Expand Down
676 changes: 676 additions & 0 deletions site/_site/guide/add-a-content-block.html
View file
Open in desktop

Large diffs are not rendered by default.

Binary file added site/_site/guide/add-content-block.gif
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/_site/guide/add-content-block.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
695 changes: 695 additions & 0 deletions site/_site/guide/add-content-blocks.html
View file
Open in desktop

Large diffs are not rendered by default.

10 changes: 8 additions & 2 deletions site/_site/guide/collaborate-on-documentation-projects.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.3.361">
<meta name="generator" content="quarto-1.3.433">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

Expand Down Expand Up @@ -213,6 +213,12 @@
<a href="../guide/document-models-with-framework.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Document models with the Developer Framework</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/add-a-content-block.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Add a content block to documentation</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down Expand Up @@ -472,7 +478,7 @@ <h3 class="anchored" data-anchor-id="restoring-a-version">Restoring a version</h
</section>
<section id="real-time-collaboration" class="level2">
<h2 class="anchored" data-anchor-id="real-time-collaboration">Real-time collaboration</h2>
<p>Users can simultaneously edit the documentation project, leave and respond to comments suggestions, and access revision history. CKEditor is also integrated with ValidMind’s activity feed, so changes to the documentation project are automatically added to the activity feed.</p>
<p>Users can simultaneously edit the documentation project, leave and respond to comments suggestions, and access revision history. Changes to the documentation project are also automatically added to ValidMind’s activity feed.</p>
</section>
<section id="additional-features" class="level2">
<h2 class="anchored" data-anchor-id="additional-features">Additional features</h2>
Expand Down
6 changes: 6 additions & 0 deletions site/_site/guide/comment-on-documentation-projects.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,12 @@
<a href="../guide/document-models-with-framework.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Document models with the Developer Framework</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/add-a-content-block.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Add a content block to documentation</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down
6 changes: 6 additions & 0 deletions site/_site/guide/configure-aws-privatelink.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,12 @@
<a href="../guide/document-models-with-framework.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Document models with the Developer Framework</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/add-a-content-block.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Add a content block to documentation</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down
6 changes: 6 additions & 0 deletions site/_site/guide/create-documentation-project.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,12 @@
<a href="../guide/document-models-with-framework.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Document models with the Developer Framework</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/add-content-blocks.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Add content blocks to documentation</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down
6 changes: 6 additions & 0 deletions site/_site/guide/document-models-with-framework.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,12 @@
<a href="../guide/document-models-with-framework.html" class="sidebar-item-text sidebar-link active">
<span class="menu-text">Document models with the Developer Framework</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/add-content-blocks.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Add content blocks to documentation</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down
6 changes: 6 additions & 0 deletions site/_site/guide/document-models-with-ui.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,12 @@
<a href="../guide/document-models-with-framework.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Document models with the Developer Framework</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/add-a-content-block.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Add a content block to documentation</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down
6 changes: 6 additions & 0 deletions site/_site/guide/edit-model-inventory-fields.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,12 @@
<a href="../guide/document-models-with-framework.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Document models with the Developer Framework</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/add-a-content-block.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Add a content block to documentation</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down
6 changes: 6 additions & 0 deletions site/_site/guide/edit-templates.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,12 @@
<a href="../guide/document-models-with-framework.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Document models with the Developer Framework</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/add-a-content-block.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Add a content block to documentation</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down
6 changes: 6 additions & 0 deletions site/_site/guide/export-documentation.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,12 @@
<a href="../guide/document-models-with-framework.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Document models with the Developer Framework</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/add-a-content-block.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Add a content block to documentation</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down
6 changes: 6 additions & 0 deletions site/_site/guide/guide.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,12 @@
<a href="../guide/document-models-with-framework.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Document models with the Developer Framework</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/add-content-blocks.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Add content blocks to documentation</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down
8 changes: 7 additions & 1 deletion site/_site/guide/load-credentials-to-env-file.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.3.361">
<meta name="generator" content="quarto-1.3.433">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

Expand Down Expand Up @@ -211,6 +211,12 @@
<a href="../guide/document-models-with-framework.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Document models with the Developer Framework</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/add-content-blocks.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Add content blocks to documentation</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down
6 changes: 6 additions & 0 deletions site/_site/guide/login.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,12 @@
<a href="../guide/document-models-with-framework.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Document models with the Developer Framework</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/add-a-content-block.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Add a content block to documentation</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down
8 changes: 7 additions & 1 deletion site/_site/guide/register-models.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,12 @@
<a href="../guide/document-models-with-framework.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Document models with the Developer Framework</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/add-content-blocks.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Add content blocks to documentation</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down Expand Up @@ -346,7 +352,7 @@ <h1 class="title">Register models in the inventory</h1>

</header>

<p>Learn how to register a model you are documenting in the model inventory. This topic is relevant for model owners who want to enbale their model development teams to use ValidMind’s model documentation and validation features.</p>
<p>Learn how to register a model you are documenting in the model inventory. This topic is relevant for model owners who want to enable their model development teams to use ValidMind’s model documentation and validation features.</p>
<section id="prerequisites" class="level2">
<h2 class="anchored" data-anchor-id="prerequisites">Prerequisites</h2>
<ul>
Expand Down
6 changes: 6 additions & 0 deletions site/_site/guide/review-data-streams-and-audit-trails.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,12 @@
<a href="../guide/document-models-with-framework.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Document models with the Developer Framework</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/add-a-content-block.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Add a content block to documentation</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down
6 changes: 6 additions & 0 deletions site/_site/guide/review-documentation-project.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,12 @@
<a href="../guide/document-models-with-framework.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Document models with the Developer Framework</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/add-a-content-block.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Add a content block to documentation</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down
6 changes: 6 additions & 0 deletions site/_site/guide/submit-for-approval.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,12 @@
<a href="../guide/document-models-with-framework.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Document models with the Developer Framework</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/add-a-content-block.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Add a content block to documentation</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down
2 changes: 1 addition & 1 deletion site/_site/guide/support.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.3.361">
<meta name="generator" content="quarto-1.3.433">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

Expand Down
2 changes: 1 addition & 1 deletion site/_site/guide/troubleshooting.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.3.361">
<meta name="generator" content="quarto-1.3.433">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

Expand Down
6 changes: 6 additions & 0 deletions site/_site/guide/view-all-test-plans.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,12 @@
<a href="../guide/document-models-with-framework.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Document models with the Developer Framework</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/add-a-content-block.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Add a content block to documentation</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down
6 changes: 6 additions & 0 deletions site/_site/guide/view-documentation-guidelines.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,12 @@
<a href="../guide/document-models-with-framework.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Document models with the Developer Framework</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/add-a-content-block.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Add a content block to documentation</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down
6 changes: 6 additions & 0 deletions site/_site/guide/view-templates.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,12 @@
<a href="../guide/document-models-with-framework.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Document models with the Developer Framework</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/add-a-content-block.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Add a content block to documentation</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down
6 changes: 6 additions & 0 deletions site/_site/guide/view-validation-guidelines.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,12 @@
<a href="../guide/document-models-with-framework.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Document models with the Developer Framework</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/add-a-content-block.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Add a content block to documentation</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down
6 changes: 6 additions & 0 deletions site/_site/guide/work-with-validation-reports.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,12 @@
<a href="../guide/document-models-with-framework.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Document models with the Developer Framework</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../guide/add-a-content-block.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Add a content block to documentation</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down
Loading