Skip to content

Commit 3798d37

Browse files
nrichersvalidbeck
andauthored
Release notes to sprint 60 (#483)
* Generate initial release notes * Fix LUA error * WIP edits * Initial edit pass & add images * Add new button to styles.css * Clean up styles.css * WIP more edits * WIP more edits * WIP more edits * Update button style * WIP edits * Second edit pass complete * Add button info to style guide * Minor edits * Fix broken link * Run make get-source * Final tweaks * Remove release notes notebook * Improved hover state for buttons * Adjusted style guide & README * Tweak to the convention example * Oops, I can't spell * Remove _blank guidance * Round screenshot corners more * Add fig-alt text * Address review comments from Beck * Add upgrade info and crop screencap * Ambiguous antecedents are a bad habit * Visual tweaks * Summary & final touches --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
1 parent 75de804 commit 3798d37

17 files changed

+662
-10
lines changed

README.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -101,14 +101,6 @@ When constructing links, refer to the `.qmd` file as Quarto will properly render
101101
|---|---|
102102
| `[Get started with JupyterHub](get-started/developer/try-with-jupyterhub.qmd)` | `[Get started with JupyterHub](get-started/developer/try-with-jupyterhub.html)` |
103103

104-
The only exceptions are within HTML, such as CSS-styled buttons which necessitate usage of `.html` href links:
105-
106-
```html
107-
<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>
108-
```
109-
110-
> 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.
111-
112104
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:
113105

114106
| Correct | Incorrect |

site/_quarto.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ website:
112112
- text: "---"
113113
- text: "RELEASES"
114114
# MAKE-RELEASE-NOTES-EMBED-MARKER
115+
- releases/2024-oct-22/release-notes.qmd
115116
- releases/2024-sep-25/release-notes.qmd
116117
- releases/2024-sep-09/release-notes.qmd
117118
- releases/2024-aug-13/release-notes.qmd

site/about/contributing/style-guide/conventions.qmd

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,52 @@ Column 2, 50% wide
119119
- Keep hyperlinks in instructional text minimal — too many links can misdirect the user from the task at hand.
120120
- When possible — such as any time instructions are not single-sourced — instead of multiple inline links, make use of margin footnotes.[^5]
121121
- 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."
122+
- 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.
123+
- When constructing filepaths, you'll also want start with the root directory whenever possible as this minimizes usage of unclear relative paths.
124+
125+
| Correct | Incorrect |
126+
|------|-----|
127+
| `[Set up model workflows](/guide/model-workflows/set-up-model-workflows.qmd)` | `[Learn more ...](/../../set-up-model-workflows.html)` |
128+
: **Inline links** examples {.hover}
129+
130+
#### Buttons
131+
132+
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.
133+
134+
Change any Markdown link into a our theme-styled button by appending `{.button}`:
135+
136+
:::: {.flex .flex-wrap .justify-around}
137+
138+
::: {.w-30-ns}
139+
**Correct:**
140+
141+
[Set up model workflows](/guide/model-workflows/set-up-model-workflows.qmd){.button}
142+
143+
```markdown
144+
[Set up model workflows](/guide/model-workflows/set-up-model-workflows.qmd){.button}
145+
```
146+
147+
::: {.callout}
148+
Using a markdown button also enables you to link to to the `.qmd` path instead of the rendered `.html` file.
149+
:::
150+
151+
:::
152+
153+
::: {.w-60-ns}
154+
**Incorrect:**
155+
156+
<form method="get" action="../../../guide/model-workflows/set-up-model-workflows.html">
157+
<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>
158+
</form>
159+
160+
```html
161+
<form method="get" action="../../../guide/model-workflows/set-up-model-workflows.html">
162+
<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>
163+
</form>
164+
```
165+
:::
166+
167+
::::
122168

123169
#### Margin footnotes
124170

site/guide/monitoring/ongoing-monitoring.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Monitoring is a critical component of model risk management, as emphasized in re
3434

3535

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

4040

site/index.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,12 @@ listing:
4545
sort: false
4646
fields: [title, description]
4747
contents:
48+
- 2024-oct-22/release-notes.qmd
4849
- 2024-sep-25/release-notes.qmd
4950
- 2024-sep-09/release-notes.qmd
5051
- 2024-aug-13/release-notes.qmd
5152
- 2024-jul-22/release-notes.qmd
5253
- 2024-jun-10/release-notes.qmd
53-
- 2024-may-22/release-notes.qmd
5454
---
5555

5656
```{=html}

site/notebooks.zip

0 Bytes
Binary file not shown.

site/python-docs.zip

0 Bytes
Binary file not shown.
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading

0 commit comments

Comments
 (0)