Skip to content

Merge main into staging #456

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 2 commits into from
Sep 26, 2024
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
33 changes: 0 additions & 33 deletions internal/templates/page-moved.qmd

This file was deleted.

3 changes: 3 additions & 0 deletions site/about/contributing/join-community.qmd
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title: ""
# date: last-modified
aliases:
- ../guide/join-community.html
- ../join-community.html
---

```{=html}
Expand Down
58 changes: 36 additions & 22 deletions site/about/contributing/style-guide/conventions.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,18 @@ Filenames should generally match the title of the article[^9] or concisely summa
| `model-lifecycle.gif` | `img4.gif`|
: **Filenames** examples {.hover}

::: {.callout-important title="If you move or rename a file, use a Quarto alias to redirect users to the new page."}
For example, for an original file named `site/guide/overview.qmd` moved and renamed to `site/about/new-overview.qmd`, you would insert the following into the `new-overview.qmd`'s YAML header:[^10]

```YAML
---
title: "New overview"
aliases:
- ../guide/overview.html
---
```
:::

#### Screenshots

- Screen captures of the UI or other elements to assist users with their tasks should have the `.screenshot` class applied to them, which will add a border distinguishing the image from the rest of the text.
Expand All @@ -254,10 +266,10 @@ Filenames should generally match the title of the article[^9] or concisely summa
: **Screenshot** examples {.hover}

#### Code
- Format code in its own code block.[^10]
- Format code in its own code block.[^11]
- Declare the code language within the pre-formatted block to properly trigger syntax highlighting.

Within a Jupyter Notebook, simply use a **code cell**[^11] rather than a markdown cell.
Within a Jupyter Notebook, simply use a **code cell**[^12] rather than a markdown cell.

> **Correct**:
>```python
Expand All @@ -278,8 +290,8 @@ Use backticks to enclose keyboard commands, parameters, field values, and file n
: **Backtick** examples {.hover}

#### Mathematics
- Mathematical formulas should be rendered using LaTeX formatting.[^12]
- On our WordPress blog posts, this is taken care of by the WP Quick LaTeX plugin.[^13]
- Mathematical formulas should be rendered using LaTeX formatting.[^13]
- On our WordPress blog posts, this is taken care of by the WP Quick LaTeX plugin.[^14]

| Correct | Incorrect |
|------|-----|
Expand All @@ -300,11 +312,11 @@ In the context of model risk management, proper nouns include specific models, l
: **Proper noun** examples {.hover}

## Product names
Within our documentation (`https://docs.validmind.ai/`), you are able to reference constants such as the {{< var validmind.developer >}} and {{< var validmind.platform >}} via variables.[^14]
Within our documentation (`https://docs.validmind.ai/`), you are able to reference constants such as the {{< var validmind.developer >}} and {{< var validmind.platform >}} via variables.[^15]

- Use the variables shown on the table below instead of writing out the phrases to enable consistency between guides everywhere except for image alt text or Mermaid charts.[^15]
- If product names need to be updated, simply amend the `_variables.yml` file[^16] to see changes reflected throughout all guides.
- Please note that variables will not work within any of the Jupyter Notebook code samples[^17] as these are technically standalone files.
- Use the variables shown on the table below instead of writing out the phrases to enable consistency between guides everywhere except for image alt text or Mermaid charts.[^16]
- If product names need to be updated, simply amend the `_variables.yml` file[^17] to see changes reflected throughout all guides.
- Please note that variables will not work within any of the Jupyter Notebook code samples[^18] as these are technically standalone files.

| Product Name | Variable Key | Description |
|---:|---|---|
Expand All @@ -322,9 +334,9 @@ Refer also to [the glossary](/about/glossary/glossary.qmd) for extended informat

## Training materials

The ValidMind Academy is delivered in Revealjs presentation format,[^18] with a slightly different set of conventions:
The ValidMind Academy is delivered in Revealjs presentation format,[^19] with a slightly different set of conventions:

- It makes use of Tachyons CSS[^19] to provide demonstration overlays.
- It makes use of Tachyons CSS[^20] to provide demonstration overlays.

Enable Tachyons CSS in the front matter with:

Expand Down Expand Up @@ -365,7 +377,7 @@ The ValidMind Academy is delivered in Revealjs presentation format,[^18] with a
::::


- It uses inline links only instead of footnotes,[^20] as footnotes are not visible in presentation mode.
- It uses inline links only instead of footnotes,[^21] as footnotes are not visible in presentation mode.

## What's next
- [Voice and tone](voice-and-tone.qmd)
Expand All @@ -391,24 +403,26 @@ The ValidMind Academy is delivered in Revealjs presentation format,[^18] with a

[^9]: [Titles](#titles)

[^10]: **Quarto:** [Source Code](https://quarto.org/docs/authoring/markdown-basics.html#source-code)
[^10]: **Quarto:** [Redirects](https://quarto.org/docs/websites/website-navigation.html#redirects)

[^11]: **Quarto:** [Source Code](https://quarto.org/docs/authoring/markdown-basics.html#source-code)

[^11]: **Jupyter Notebooks:** [Code Cells](https://jupyter-notebook.readthedocs.io/en/stable/notebook.html#code-cells)
[^12]: **Jupyter Notebooks:** [Code Cells](https://jupyter-notebook.readthedocs.io/en/stable/notebook.html#code-cells)

[^12]: **Quarto:** [LaTeX Equations](https://quarto.org/docs/output-formats/html-basics.html#latex-equations)
[^13]: **Quarto:** [LaTeX Equations](https://quarto.org/docs/output-formats/html-basics.html#latex-equations)

[^13]: **WordPress:** [WP QuickLaTeX](https://en-gb.wordpress.org/plugins/wp-quicklatex/)
[^14]: **WordPress:** [WP QuickLaTeX](https://en-gb.wordpress.org/plugins/wp-quicklatex/)

[^14]: **Quarto:** [Variables](https://quarto.org/docs/authoring/variables.html#var)
[^15]: **Quarto:** [Variables](https://quarto.org/docs/authoring/variables.html#var)

[^15]: [Mermaid charts](https://mermaid.js.org/)
[^16]: [Mermaid charts](https://mermaid.js.org/)

[^16]: [`_variables.yml`](https://github.com/validmind/documentation/blob/main/site/_variables.yml) file
[^17]: [`_variables.yml`](https://github.com/validmind/documentation/blob/main/site/_variables.yml) file

[^17]: [Code samples](/developer/samples-jupyter-notebooks.qmd)
[^18]: [Code samples](/developer/samples-jupyter-notebooks.qmd)

[^18]: **Quarto:** [Revealjs](https://quarto.org/docs/presentations/revealjs/)
[^19]: **Quarto:** [Revealjs](https://quarto.org/docs/presentations/revealjs/)

[^19]: **GitHub:** [Tachyons Extension For Quarto](https://github.com/nareal/tachyons)
[^20]: **GitHub:** [Tachyons Extension For Quarto](https://github.com/nareal/tachyons)

[^20]: [Inline links](#inline-links)
[^21]: [Inline links](#inline-links)
2 changes: 2 additions & 0 deletions site/about/contributing/style-guide/style-guide.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ listing:
contents:
- voice-and-tone.qmd
- conventions.qmd
aliases:
- ../../style-guide.html
---

A style guide helps create distinct yet unified communication across all areas of a product experience, from in-app interactions to technical documentation and blog posts.
Expand Down
2 changes: 2 additions & 0 deletions site/about/contributing/validmind-community.qmd
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: "ValidMind community"
date: last-modified
aliases:
- ../validmind-commmunity.html
---

Work with financial models, in model risk management (MRM), or are simply enthusiastic about artificial intelligence (AI) and machine learning and how these tools are actively shaping our futures within the finance industry and beyond? Congratulations — you're already part of the ValidMind community! Come learn and play with us.
Expand Down
3 changes: 3 additions & 0 deletions site/about/fine-print/data-privacy-policy.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
title: "Data privacy policy"
keywords: "data privacy, ai risk, model risk management, ValidMind"
date: last-modified
aliases:
- ../data-privacy-policy.html
- ../guide/data-privacy-policy.html
---

This page outlines ValidMind's data privacy policy, explaining how we protect your personal information. Our goal is to provide transparency about our data handling practices and to demonstrate our commitment to protecting your privacy and data security.
Expand Down
3 changes: 3 additions & 0 deletions site/about/fine-print/license-agreement.qmd
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title: "SOFTWARE LICENSE AGREEMENT"
date: last-modified
aliases:
- ../license-agreement.html
- ../guide/license-agreement.html
---

IMPORTANT: READ THIS SOFTWARE LICENSE AGREEMENT (THIS “AGREEMENT”) CAREFULLY BEFORE USING THE SOFTWARE. BY USING THE SOFTWARE, YOU ARE AGREEING TO BE BOUND BY THE TERMS OF THIS LICENSE AGREEMENT:
Expand Down
2 changes: 2 additions & 0 deletions site/about/overview-model-documentation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: "Automated model testing & documentation"
date: last-modified
filters:
- tachyons
aliases:
- ../guide/overview-model-documentation.html
---

<!---
Expand Down
2 changes: 2 additions & 0 deletions site/about/overview-model-risk-management.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: "Model risk management"
date: last-modified
filters:
- tachyons
aliases:
- ../guide/overview-model-risk-management.html
---

<!---
Expand Down
2 changes: 2 additions & 0 deletions site/about/overview.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ listing:
- overview-model-risk-management.qmd
filters:
- tachyons
aliases:
- ../guide/overview.html
---

<!---
Expand Down
4 changes: 4 additions & 0 deletions site/developer/get-started-developer-framework.qmd
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
---
title: "Get started with the {{< var validmind.developer >}}"
date: last-modified
aliases:
- ../guide/get-started-developer-framework.html
- ../guide/developer-framework.html
- ../guide/restapi.html
listing:
- id: developer-getting-started
type: grid
Expand Down
4 changes: 4 additions & 0 deletions site/developer/model-documentation/documenting-models.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ listing:
- install-and-initialize-client-library.qmd
- work-with-test-results.qmd
- store-credentials-in-env-file.qmd
aliases:
- generating-model-documentation.html
- generate-model-documentation.html
- ../../guide/generate-model-documentation.html
---

Use the {{< var vm.developer >}} to generate model documentation, view the results and refine your documentation in the {{< var vm.platform >}}, and collaborate with your team to complete documentation and validation projects within the same interface.
Expand Down

This file was deleted.

Loading