Skip to content

Commit 2e8fe33

Browse files
committed
docs: fix misc warnings that should be admonitions
1 parent f424ff1 commit 2e8fe33

File tree

2 files changed

+16
-10
lines changed

2 files changed

+16
-10
lines changed

docs/source/administrator/security.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,9 @@ some extent.
367367
| `autohttps` | From pods labelled `hub.jupyter.org/network-access-proxy-http=true` (http(s) proxy ports) |
368368
| `singleuser` | From pods labelled `hub.jupyter.org/network-access-singleuser=true` (notebook-port) |
369369

370-
````{warning} Not all functionality summarized above
370+
````{admonition} Not all functionality summarized above
371+
:class: warning
372+
371373
It has been tricky to document the full behavior of these network policies. For
372374
in depth details, please for now refer to inspecting the Helm chart's templates
373375
and the rendered result given your configuration.

docs/source/changelog.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,14 @@ changes in pull requests], this list should be updated.
5050

5151
### 3.3.0 - 2024-03-20
5252

53-
```{warning} If you are upgrading from 3.0.x
53+
```{admonition} If you are upgrading from 3.0.x
54+
:class: warning
55+
5456
A bug in KubeSpawner 5.0-6.0 present in z2jh 3.0.0-3.0.3 made user server pods
5557
risk be orphaned by JupyterHub, making them run indefinitely and cause
5658
unnecessary cloud costs.
5759
5860
Read more about how to clean up these user server pods in [this forum post].
59-
60-
[this forum post]: https://discourse.jupyter.org/t/how-to-cleanup-orphaned-user-pods-after-bug-in-z2jh-3-0-and-kubespawner-6-0/21677
6161
```
6262

6363
This release updates JupyterHub from 4.0.2 to 4.1.0 and OAuthenticator from
@@ -112,14 +112,14 @@ See [our definition of contributors](https://github-activity.readthedocs.io/en/l
112112

113113
### 3.2.0 - 2023-11-27
114114

115-
```{warning} If you are upgrading from 3.0.x
115+
```{admonition} If you are upgrading from 3.0.x
116+
:class: warning
117+
116118
A bug in KubeSpawner 5.0-6.0 present in z2jh 3.0.0-3.0.3 made user server pods
117119
risk be orphaned by JupyterHub, making them run indefinitely and cause
118120
unnecessary cloud costs.
119121
120122
Read more about how to clean up these user server pods in [this forum post].
121-
122-
[this forum post]: https://discourse.jupyter.org/t/how-to-cleanup-orphaned-user-pods-after-bug-in-z2jh-3-0-and-kubespawner-6-0/21677
123123
```
124124

125125
#### Default image registry changed to Quay.io
@@ -173,15 +173,17 @@ See [our definition of contributors](https://github-activity.readthedocs.io/en/l
173173

174174
### 3.1.0 - 2023-09-29
175175

176-
```{warning} Post-upgrade action recommended
176+
```{admonition} Post-upgrade action recommended
177+
:class: warning
178+
177179
A bug in KubeSpawner 5.0-6.0 present in z2jh 3.0.0-3.0.3 made user server pods
178180
risk be orphaned by JupyterHub, making them run indefinitely and cause
179181
unnecessary cloud costs.
180182
181183
Read more about how to clean up these user server pods in [this forum post].
184+
```
182185

183186
[this forum post]: https://discourse.jupyter.org/t/how-to-cleanup-orphaned-user-pods-after-bug-in-z2jh-3-0-and-kubespawner-6-0/21677
184-
```
185187

186188
#### Notable dependencies updated
187189

@@ -258,7 +260,9 @@ See [our definition of contributors](https://github-activity.readthedocs.io/en/l
258260
This release updates JupyterHub itself and several dependencies to a new major
259261
version, please read the breaking changes below before upgrading.
260262

261-
```{warning} Breaking changes since beta releases
263+
```{admonition} Breaking changes since beta releases
264+
:class: warning
265+
262266
Since 3.0.0-beta.1 OAuthenticator was upgraded, and since 3.0.0-beta.3 default
263267
networking rules related to establishing connections to DNS ports changed
264268
slightly.

0 commit comments

Comments
 (0)