Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Trilium Demo notes branch review and update #487

Open
1 of 2 tasks
maphew opened this issue Oct 14, 2024 · 6 comments
Open
1 of 2 tasks

Trilium Demo notes branch review and update #487

maphew opened this issue Oct 14, 2024 · 6 comments

Comments

@maphew
Copy link
Contributor

maphew commented Oct 14, 2024

Describe feature

The Trilium Demo branch which ships with the default database should be reviewed and updated

@eliandoran
Copy link
Contributor

eliandoran commented Oct 14, 2024

@maphew ,

new note types demo'd (ex: Mind Maps)

This point should already be addressed since the first beta which introduced the mindmap.

Do note that the demo branch is not kept up to date in your local database. The only way to see the latest demo is to start off with an empty database.

@maphew
Copy link
Contributor Author

maphew commented Oct 14, 2024

Do note that the demo branch is not kept up to date in your local database. The only way to see the latest demo is to start off with an empty database.

Oh! Of course. That points to an enhancement of: publishing Trilium Demo as part of the docs, but that won't work unless/until docs are served from Trilium instead of static html. Or an "import latest of this branch" mechanism, which in turn would rely on a possible future multi-database scenario.

@maphew
Copy link
Contributor Author

maphew commented Oct 15, 2024

https://triliumnext.github.io/Docs/Wiki/database.html#restoring-demo-notes has a procedure for fetching/restoring the demo notes outside of initial install time, but it relies on importing a .zip from stable, which doesn't currently exist.

I guess a github action will need to be created to make this archive as part of the release process?

@eliandoran
Copy link
Contributor

eliandoran commented Oct 15, 2024

@maphew , on our side we don't use the stable branch anymore.
You can use https://github.com/TriliumNext/Notes/blob/develop/db/demo.zip (or https://github.com/TriliumNext/Notes/raw/develop/db/demo.zip for a direct download) instead.

@pano9000
Copy link
Member

if I may add my 2 cents here on this topic:

I am not sure if using a binary .zip file is the best way to handle the demo notes -- it is definitely easier to ship it this way for the releases, but managing it during dev - is a bit a pain in the ass:

  • the actual demo notes are not versioned
  • doing updates to the demo notes requires manual unzipping and zipping again
  • you cannot easily check what changes really were made, (unless you manually unpack the zip and diff every single file)
  • binary files can be more easily used for evil stuff :-) (e.g. the xz backdoor incident was also "introduced" via such a binary file IIRC)

So an idea here: maybe we should look into finding a way to have the demo files as actual files and only bundle them into a zip file when building for a release (or via some simple script, if required for dev testing).

what are your thoughts?

@maphew
Copy link
Contributor Author

maphew commented Jan 25, 2025

generally I think you're right Pano, however the demo notes are created in and with Trilium so there's always* going to be an export >> zip >> ship >> import set of activities, and associated diffing for changes. However there could be some trilium scripts made so it's less annoying (?)

* until there's a trilium-to-trilium sync-this-branch API. I don't think anyone is both itchy and knowledgeable enough to take that major project on yet

@pano9000 pano9000 changed the title (Feature request) Trilium Demo notes branch review and update Trilium Demo notes branch review and update Mar 12, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants