Skip to content

Commit 7b2844c

Browse files
committed
add under-construction admonition; document custom admonitions in contributing
1 parent 1c1b720 commit 7b2844c

File tree

3 files changed

+81
-0
lines changed

3 files changed

+81
-0
lines changed

docs/alps/hardware.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,11 @@ There are currently four node types in Alps, with another becoming available in
5151
[](){#ref-alps-gh200-node}
5252
### NVIDIA GH200 GPU Nodes
5353

54+
!!! under-construction
55+
The description of the GH200 nodes is incomplete.
56+
57+
Let us know if there is missing information.
58+
5459
There are 24 cabinets, in 4 rows with 6 cabinets per row:
5560

5661
* 8 chassis per cabinet

docs/contributing/index.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,66 @@ They stand out better from the main text, and can be collapsed by default if nee
229229

230230
If an admonition is collapsed by default, it should have a title.
231231

232+
We provide some custom admonitions.
233+
234+
#### Change
235+
236+
For adding information about a change, originally designed for recording updates to clusters.
237+
238+
=== "Rendered"
239+
!!! change "2025-04-17"
240+
* SLURM was upgraded to version 25.1.
241+
* uenv was upgraded to v0.8
242+
243+
Old changes can be folded:
244+
245+
??? change "2025-02-04"
246+
* The new Scratch cleanup policy was implemented
247+
* NVIDIA driver was updated
248+
249+
=== "Markdown"
250+
```
251+
!!! change "2025-04-17"
252+
* SLURM was upgraded to version 25.1.
253+
* uenv was upgraded to v0.8
254+
```
255+
256+
Old changes can be folded:
257+
258+
```
259+
??? change "2025-02-04"
260+
* The new Scratch cleanup policy was implemented
261+
* NVIDIA driver was updated
262+
```
263+
264+
#### Under construction
265+
266+
For marking incomplete sections.
267+
268+
=== "Rendered"
269+
!!! under-construction
270+
This is not finished yet!
271+
272+
=== "Markdown"
273+
```
274+
!!! under-construction
275+
This is not finished yet!
276+
```
277+
278+
#### Todo
279+
280+
As a placeholder for documentation that needs to be written.
281+
282+
=== "Rendered"
283+
!!! todo
284+
Add some common error messages and how to fix them.
285+
286+
=== "Markdown"
287+
```
288+
!!! todo
289+
Add some common error messages and how to fix them.
290+
```
291+
232292
### Code blocks
233293

234294
Use [code blocks](https://squidfunk.github.io/mkdocs-material/reference/code-blocks/) when you want to display monospace text in a programming language, terminal output, configuration files etc.

docs/stylesheets/extra.css

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,22 @@
5353
mask-image: var(--md-admonition-icon--alps);
5454
}
5555

56+
/* under-construction admonition */
57+
.md-typeset .admonition.under-construction,
58+
.md-typeset details.under-construction {
59+
border-color: rgb(0, 0, 0);
60+
}
61+
.md-typeset .under-construction > .admonition-title,
62+
.md-typeset .under-construction > summary {
63+
background-color: rgba(255, 255, 0, 0.3);
64+
}
65+
.md-typeset .under-construction > .admonition-title::before,
66+
.md-typeset .under-construction > summary::before {
67+
background-color: rgb(0, 0, 0);
68+
-webkit-mask-image: var(--md-admonition-icon--digging);
69+
mask-image: var(--md-admonition-icon--digging);
70+
}
71+
5672
.md-nav__item .md-nav__link--active {
5773
font-weight: bold;
5874
}

0 commit comments

Comments
 (0)