Skip to content

Merge main into staging #485

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
Oct 22, 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
8 changes: 0 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,14 +101,6 @@ When constructing links, refer to the `.qmd` file as Quarto will properly render
|---|---|
| `[Get started with JupyterHub](get-started/developer/try-with-jupyterhub.qmd)` | `[Get started with JupyterHub](get-started/developer/try-with-jupyterhub.html)` |

The only exceptions are within HTML, such as CSS-styled buttons which necessitate usage of `.html` href links:

```html
<a class="btn btn-primary" role="button" style="padding: 12px;color: var(--bs-white);background: #DE257E;border-radius: 4px;margin-top: 40px;font-family: 'Inter';font-style: normal;font-weight: 700;font-size: 14px;line-height: 100%;border: 1px solid var(--bs-pink);" href="get-started/developer/try-with-jupyterhub.html">QuickStart</a>
```

> You'll need to pay special attention to these links and manually test them to ensure that they are not broken whenever any changes to file destinations are made.

When constructing filepaths, including while using [Quarto's Includes](https://quarto.org/docs/authoring/includes.html) (single-sourcing feature), you'll also want start with the root directory whenever possible as this minimizes usage of unclear relative paths:

| Correct | Incorrect |
Expand Down
1 change: 1 addition & 0 deletions site/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ website:
- text: "---"
- text: "RELEASES"
# MAKE-RELEASE-NOTES-EMBED-MARKER
- releases/2024-oct-22/release-notes.qmd
- releases/2024-sep-25/release-notes.qmd
- releases/2024-sep-09/release-notes.qmd
- releases/2024-aug-13/release-notes.qmd
Expand Down
46 changes: 46 additions & 0 deletions site/about/contributing/style-guide/conventions.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,52 @@ Column 2, 50% wide
- Keep hyperlinks in instructional text minimal — too many links can misdirect the user from the task at hand.
- When possible — such as any time instructions are not single-sourced — instead of multiple inline links, make use of margin footnotes.[^5]
- Whenever possible, make the link the title of the destination article. This also solves the issue of links with nebulous descriptions that do not match article titles, or links whose destinations are not clear to the user such as "Read more."
- When constructing links, refer to the `.qmd` file as Quarto will properly render these into `.html` links on your behalf and check to see if the destinations are able to be resolved.
- When constructing filepaths, you'll also want start with the root directory whenever possible as this minimizes usage of unclear relative paths.

| Correct | Incorrect |
|------|-----|
| `[Set up model workflows](/guide/model-workflows/set-up-model-workflows.qmd)` | `[Learn more ...](/../../set-up-model-workflows.html)` |
: **Inline links** examples {.hover}

#### Buttons

Sometimes, it's helpful to highlight a call to action with a button that takes you to a topic or to a notebook on JupyterHub.

Change any Markdown link into a our theme-styled button by appending `{.button}`:

:::: {.flex .flex-wrap .justify-around}

::: {.w-30-ns}
**Correct:**

[Set up model workflows](/guide/model-workflows/set-up-model-workflows.qmd){.button}

```markdown
[Set up model workflows](/guide/model-workflows/set-up-model-workflows.qmd){.button}
```

::: {.callout}
Using a markdown button also enables you to link to to the `.qmd` path instead of the rendered `.html` file.
:::

:::

::: {.w-60-ns}
**Incorrect:**

<form method="get" action="../../../guide/model-workflows/set-up-model-workflows.html">
<button type="submit" style="color: #de257e; background-color: white; border-radius: 8px; border: none; font-size: 16px; padding: 6.25px 12.5px; margin-left: 16px; margin-bottom: 20px;border: 1px solid #de257e">Set up model workflows</button>
</form>

```html
<form method="get" action="../../../guide/model-workflows/set-up-model-workflows.html">
<button type="submit" style="color: white; background-color: #de257e; border-radius: 8px; border: none; font-size: 16px; padding: 6.25px 12.5px; margin-left: 16px; margin-bottom: 20px;">Set up model workflows</button>
</form>
```
:::

::::

#### Margin footnotes

Expand Down
2 changes: 1 addition & 1 deletion site/guide/monitoring/ongoing-monitoring.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Monitoring is a critical component of model risk management, as emphasized in re


::: {.column-margin}
![Sample monitoring results](target-prediction-distribution-plot-zoomed.png){fig-alt="An image showing sample monitoring results in the ValidMind platform"ç
![Sample monitoring results](target-prediction-distribution-plot-zoomed.png){fig-alt="An image showing sample monitoring results in the ValidMind platform"}
:::


Expand Down
2 changes: 1 addition & 1 deletion site/index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,12 @@ listing:
sort: false
fields: [title, description]
contents:
- 2024-oct-22/release-notes.qmd
- 2024-sep-25/release-notes.qmd
- 2024-sep-09/release-notes.qmd
- 2024-aug-13/release-notes.qmd
- 2024-jul-22/release-notes.qmd
- 2024-jun-10/release-notes.qmd
- 2024-may-22/release-notes.qmd
---

```{=html}
Expand Down
Binary file modified site/notebooks.zip
Binary file not shown.
Binary file modified site/python-docs.zip
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading