From 3a348944925914b21739b5e9a841d92c1322089b Mon Sep 17 00:00:00 2001 From: "Itai Y. Efrat" Date: Wed, 22 Dec 2021 16:23:51 +0200 Subject: [PATCH] docs(org): warn about org-roam-v1 status - add doctor warning about eventual removal - clarify the readme notice, since the migration-wizard has stabilized --- modules/lang/org/README.org | 7 ++----- modules/lang/org/doctor.el | 2 ++ 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/modules/lang/org/README.org b/modules/lang/org/README.org index fd7559dcd..2c60f4c66 100644 --- a/modules/lang/org/README.org +++ b/modules/lang/org/README.org @@ -265,7 +265,8 @@ For =evil-mode= users, an overview of org-mode keybindings is provided [[https:/ *** Should I go with =+roam= (v1) or =+roam2= (v2)? Long story short: if you're new to [[doom-package:org-roam]] and haven't used it, then you should go with [[doom-module:+roam2]]; if you already have an ~org-roam-directory~ with the v1 files in -it, then you can keep use [[doom-module:+roam]] for a time being. +it, then you can keep use [[doom-module:+roam]] for the time being, but it will eventually be +removed, so you should [[https://www.orgroam.com/manual.html#How-to-migrate-from-Org_002droam-v1_003f][migrate]] at your earliest convenience. V1 isn't actively maintained anymore and is now basically EOL. This means that the feature disparity between the both will continue to grow, while its existing @@ -273,10 +274,6 @@ bugs and problems won't be addressed, at least by the main maintainers. V2 can be considered as a complete rewrite of the package so it comes with a lot of breaking changes. -While v1 won't be actively maintained anymore, it still will be available in -Doom for a while, at least until there will be a reliable tool that will migrate -your data from v1 to v2. - To learn more about v2 you can use the next resources: - [[https://github.com/org-roam/org-roam/blob/master/doc/org-roam.org][Org-roam v2 Official Manual]] - [[https://github.com/org-roam/org-roam/wiki/Hitchhiker's-Rough-Guide-to-Org-roam-V2][Hitchhiker's Rough Guide to Org roam V2]] diff --git a/modules/lang/org/doctor.el b/modules/lang/org/doctor.el index cb31b084f..38e659fe3 100644 --- a/modules/lang/org/doctor.el +++ b/modules/lang/org/doctor.el @@ -6,6 +6,8 @@ (warn! "Couldn't find gnuplot. org-plot/gnuplot will not work"))) (when (modulep! +roam) + (warn! "You are using org-roam-v1. This version is unmaintained Doom support for it will eventually be removed.\ +Migrate your notes to org-roam-v2 and switch to the +roam2 flag (see the module readme).") (unless (executable-find "sqlite3") (warn! "Couldn't find the sqlite3 executable. org-roam will not work."))) (when (or (modulep! +roam)