Skip to content

Commit d9850e7

Browse files
authored
Update CHANGELOG (#1456)
Move down the 0.5.0 highlights
1 parent 110d6bc commit d9850e7

File tree

1 file changed

+47
-58
lines changed

1 file changed

+47
-58
lines changed

CHANGELOG.md

Lines changed: 47 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,15 @@
11
# Voila Changelog
22

3-
## 0.5.0 - Highlights
4-
5-
Below are the major highlights in Voila 0.5.0
6-
7-
### New JupyterLab-based frontend
8-
9-
In 0.5.0, the frontend of Voila is rebuilt from scratch with JupyterLab 4.0 components. The current `requirejs` + `nbextensions` approach is replaced by a JupyterLab plugin-based application.
10-
This allows Voila to profit from all the upstream features and improvements.
11-
12-
### New extension loading system.
13-
14-
This is a direct benefit of the new frontend, now Voila will use the same prebuilt extension system as in JupyterLab.
15-
The extension assets are loaded from the local path instead of the CDN. This greatly improves the extension compatibility of Voila and avoid making requests to external services.
16-
And moreover, we can start creating extensions for Voila in the same fashion as JupyterLab extensions.
17-
18-
### Make use of JupyterLab mimetype renderers.
19-
20-
In 0.5.0, the logic for rendering cell outputs is switched from relying on nbconvert for handling different mimetypes to relying on JupyterLab mimetype renderers.
21-
This adds support for many custom JupyterLab renderers like `jupyterlab-fasta`, `vega`, `jupyterlab-geojson`...
22-
23-
### New tree page.
24-
25-
The default tree page of Voila is now a JupyterLab-based application using the file browser widget.
26-
27-
The jinja-based tree page is still supported, but users need to activate it with the `--classic-tree` CLI option, the `VoilaConfiguration.classic_tree` config, or `?classic-tree=True` in the query string.
28-
29-
JupyterLab custom themes are supported with the new tree page, for the classic tree page, only the light and dark themes are supported.
30-
31-
### New token-based authentication system.
32-
33-
By using `jupyter-server` 2, Voila now supports token authentication, but it is disabled by default.
34-
35-
- To start Voila with auto-generated token:
36-
37-
```
38-
voila --token notebook.ipynb
39-
```
40-
41-
- To start Voila with a personalized token:
42-
43-
```
44-
voila --token=my-secret-token notebook.ipynb
45-
```
46-
47-
### Backwards-incompatible changes.
48-
49-
- The new tree page no longer supports templates, users need to activate the classic tree to use existing tree templates.
50-
- Theme argument now is the theme name displayed in JupyterLab and not the name of the theme python package.
51-
- Python 3.7 is no longer supported.
52-
- `jupyter_client` < 7.4.4 is no longer supported.
53-
543
<!-- <START NEW CHANGELOG ENTRY> -->
554

565
## 0.5.6
576

587
([Full Changelog](https://github.com/voila-dashboards/voila/compare/@voila-dashboards/jupyterlab-preview@2.3.5...8419cc7d79c0bb1dabfbd9ec49cb957740609d4d))
598

9+
### Security
10+
11+
Fix CVE-2024-30265
12+
6013
### Enhancements made
6114

6215
- enhancement: Allow users to disable the fix_notebook call [#1423](https://github.com/voila-dashboards/voila/pull/1423) ([@ClaytonAstrom](https://github.com/ClaytonAstrom))
@@ -185,18 +138,54 @@ voila --token=my-secret-token notebook.ipynb
185138

186139
## 0.5.0
187140

188-
([Full Changelog](https://github.com/voila-dashboards/voila/compare/v0.5.0rc0...96bffae6b5885b2bfd80983cf7026e177270ff80))
141+
Below are the major highlights in Voila 0.5.0
189142

190-
### Documentation improvements
143+
### New JupyterLab-based frontend
191144

192-
- Add highlights section to changelog [#1382](https://github.com/voila-dashboards/voila/pull/1382) ([@trungleduc](https://github.com/trungleduc))
193-
- Update documentation [#1381](https://github.com/voila-dashboards/voila/pull/1381) ([@trungleduc](https://github.com/trungleduc))
145+
In 0.5.0, the frontend of Voila is rebuilt from scratch with JupyterLab 4.0 components. The current `requirejs` + `nbextensions` approach is replaced by a JupyterLab plugin-based application.
146+
This allows Voila to profit from all the upstream features and improvements.
194147

195-
### Contributors to this release
148+
### New extension loading system.
149+
150+
This is a direct benefit of the new frontend, now Voila will use the same prebuilt extension system as in JupyterLab.
151+
The extension assets are loaded from the local path instead of the CDN. This greatly improves the extension compatibility of Voila and avoid making requests to external services.
152+
And moreover, we can start creating extensions for Voila in the same fashion as JupyterLab extensions.
153+
154+
### Make use of JupyterLab mimetype renderers.
155+
156+
In 0.5.0, the logic for rendering cell outputs is switched from relying on nbconvert for handling different mimetypes to relying on JupyterLab mimetype renderers.
157+
This adds support for many custom JupyterLab renderers like `jupyterlab-fasta`, `vega`, `jupyterlab-geojson`...
158+
159+
### New tree page.
160+
161+
The default tree page of Voila is now a JupyterLab-based application using the file browser widget.
162+
163+
The jinja-based tree page is still supported, but users need to activate it with the `--classic-tree` CLI option, the `VoilaConfiguration.classic_tree` config, or `?classic-tree=True` in the query string.
164+
165+
JupyterLab custom themes are supported with the new tree page, for the classic tree page, only the light and dark themes are supported.
166+
167+
### New token-based authentication system.
168+
169+
By using `jupyter-server` 2, Voila now supports token authentication, but it is disabled by default.
170+
171+
- To start Voila with auto-generated token:
172+
173+
```
174+
voila --token notebook.ipynb
175+
```
176+
177+
- To start Voila with a personalized token:
178+
179+
```
180+
voila --token=my-secret-token notebook.ipynb
181+
```
196182

197-
([GitHub contributors page for this release](https://github.com/voila-dashboards/voila/graphs/contributors?from=2023-08-10&to=2023-08-17&type=c))
183+
### Backwards-incompatible changes.
198184

199-
[@github-actions](https://github.com/search?q=repo%3Avoila-dashboards%2Fvoila+involves%3Agithub-actions+updated%3A2023-08-10..2023-08-17&type=Issues) | [@trungleduc](https://github.com/search?q=repo%3Avoila-dashboards%2Fvoila+involves%3Atrungleduc+updated%3A2023-08-10..2023-08-17&type=Issues)
185+
- The new tree page no longer supports templates, users need to activate the classic tree to use existing tree templates.
186+
- Theme argument now is the theme name displayed in JupyterLab and not the name of the theme python package.
187+
- Python 3.7 is no longer supported.
188+
- `jupyter_client` < 7.4.4 is no longer supported.
200189

201190
## 0.5.0rc0
202191

0 commit comments

Comments
 (0)