Skip to content

Commit

Permalink
docs(website): Add roadmap and v2-3 mention
Browse files Browse the repository at this point in the history
  • Loading branch information
jourdain committed May 12, 2023
1 parent 97bf7ff commit 97f6476
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 9 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Trame v2
# Trame

Trame v2 is not changing the ideas and concepts that made trame what it is. This new version is really focusing on a more powerful and refined suite for creating Python applications while supporting many deployment types. Trame now supports desktop, client/server, cloud services, and Jupyter notebook without changing any code.
Trame is not changing the ideas and concepts across versions that made trame what it is. Each version is all about refining its suite for creating Python applications while supporting many deployment types. Trame supports desktop, client/server, cloud services, and Jupyter notebook without changing any code.

![trame](/trame/images/trame-architecture.jpg)

Expand All @@ -18,4 +18,4 @@ With trame v2, we are deprecating PyWebVue in favor of our trame suite (trame +

In addition, since v2 formalizes how Python modules should interface with trame, the community can more easily extend trame with new widgets and/or UI elements.

Now you might be wondering if a trame v3 is planned in the near future, possibly introducing additional breaking changes. At this point we do not expect a v3 anytime soon as v2 has gave us a chance to review our api, fix what we didn't like, and simplify implementation to support our various use-cases.
Now you might be wondering if a trame v3 is planned in the near future, possibly introducing additional breaking changes. At this point we expect v3 once our vue3 widget offering is in par to our vue2 offering. We don't have a date in mind since vue3 can already be used with trame v2 and no other breaking changes is expected. But to learn more look at the __From 2 to 3__ document.
File renamed without changes.
20 changes: 20 additions & 0 deletions docs/content/docs/trame_v2-3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# From v2 to v3

Trame v3 is right around the corner. The main driver for the version 3 is to support Vue.js 3. Vue3 is already supported in trame v2, but we aim to make it the new default.

On top of making vue3 the new default, we want to shrink the default dependency list by only bundling by default the client and the server. And if the user needs vuetify and/or vtk they will need to list them as dependency of their project (trame-vtk, trame-vuetify). This will allow a leaner core package while still offering the same capabilities as before.

So far we don't have a release date, but while vuetify, vtk and more are already vue2 and 3 compatible. Not everything is available (router, plotly) or will be ported. So until we fill we have a great offering in vue3, we will hold off for the V3 release.

## New defaults

```python
from trame.app import get_server

server = get_server()
server.client_type = "vue3" # instead of 'vue2'
```

## API change

Trame in itself won't have API change but it is possible that vue3 widget will have a different API than in V2. See vuetify2 vs vuetify3. But ideally the rest will remain the same.
7 changes: 4 additions & 3 deletions docs/tpl/__en__
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,10 @@ sidebar:
api: API
cheatsheet: Cheatsheet
course: Course
trame_v2: Version 2
intro: Introduction
migration: From v1 to v2
trame_roadmap: Roadmap
roadmap_intro: Introduction
roadmap_v2: From 1 to 2
roadmap_v3: From 2 to 3
tutorial: Tutorial
t_overview: Overview
t_download: Download
Expand Down
7 changes: 4 additions & 3 deletions docs/tpl/__sidebar__
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ docs:
cheatsheet: cheatsheet.html
course: course_intro.html
vue23: vue23.html
trame_v2:
intro: trame_v2_intro.html
migration: trame_v2_migration.html
trame_roadmap:
roadmap_intro: trame_roadmap_intro.html
roadmap_v2: trame_v1-2.html
roadmap_v3: trame_v2-3.html
tutorial:
t_overview: tutorial.html
t_download: tutorial-download.html
Expand Down

0 comments on commit 97f6476

Please sign in to comment.