From 2ba87486a6685e4d584b3046a5029ad88c95a823 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ruben=20Olsen=20L=C3=A6rk?= Date: Tue, 9 Jul 2024 20:36:13 +0200 Subject: [PATCH] Roadmaps for new users (#395) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit I have added a _Roadmaps for new users_ to help people decide on their next step. The roadmaps are primarily aimed at non-technical people. I saw the reason for doing this after getting a few questions for non-techies people I know about "ehhh... where do I start?" ... "I did install the desktop software, how to get this into my cell phone", etc. --------- Co-authored-by: Ruben Olsen Lærk --- .github/actions/spelling/allow/keywords.txt | 5 ++ docs-sidebar.js | 3 +- docs/getting-started/roadmap-for-new-users.md | 46 +++++++++++++++++++ docs/index.md | 10 ++-- 4 files changed, 60 insertions(+), 4 deletions(-) create mode 100644 docs/getting-started/roadmap-for-new-users.md diff --git a/.github/actions/spelling/allow/keywords.txt b/.github/actions/spelling/allow/keywords.txt index 788c0ea72b..aaac194dda 100644 --- a/.github/actions/spelling/allow/keywords.txt +++ b/.github/actions/spelling/allow/keywords.txt @@ -51,6 +51,7 @@ libofx linting lleskassen lte +Mariushosting minimalistic monkeypatch Morrisons @@ -65,6 +66,7 @@ ofx OFX payeerule pikaday +pikapods playsinline portalization Postgresql @@ -73,11 +75,13 @@ publix QFX QIF returnsandreimbursements +roadmap Rezip RUpdate sankey screenshots SEB +Sztup subfolders subreaper subtransaction @@ -95,3 +99,4 @@ Xxxxx ynab Ynab YNAB +Zsolt diff --git a/docs-sidebar.js b/docs-sidebar.js index 614c4677f7..a82f2460a7 100644 --- a/docs-sidebar.js +++ b/docs-sidebar.js @@ -33,6 +33,7 @@ const sidebars = { label: 'Getting Started', collapsible: false, items: [ + 'getting-started/roadmap-for-new-users', { type: 'category', label: 'Installing Actual', @@ -81,10 +82,10 @@ const sidebars = { 'tour/settings', ], }, + 'getting-started/starting-fresh', 'getting-started/tips-tricks', 'getting-started/sync', 'getting-started/manage-files', - 'getting-started/starting-fresh', 'getting-started/envelope-budgeting', { type: 'category', diff --git a/docs/getting-started/roadmap-for-new-users.md b/docs/getting-started/roadmap-for-new-users.md new file mode 100644 index 0000000000..f5909a372e --- /dev/null +++ b/docs/getting-started/roadmap-for-new-users.md @@ -0,0 +1,46 @@ +# Roadmap for new users + +Welcome to Actual Budget, a delightful budgeting tool that meets you wherever you are in your financial journey. + +Our documentation is plentiful; getting started on the right track can be overwhelming unless you know where you are going. + +In other words - this very part of our documentation is for you who are entirely new to Actual. + +Below, we have outlined various use cases and, under each use case, give pointers to where to start. + +## I just want to look at screenshots before doing anything. + +Please take a look at our [Tour of Actual](/docs/tour/). + +## I want to test out Actual without committing to any work or installations. + +It's as simple as [trying our demo](https://demo.actualbudget.org/budget). +There are no strings attached; it's just a chance to explore Actual. + + +## I want to run Actual on my computer. + +If you plan to use Actual on a single computer and don't need it on your mobile or tablet, +you can [download the stand-alone software](https://github.com/actualbudget/actual/releases). + + +## I want the complete package but do not know how to run a server. + +In this case, you can use a service provider called PikaPods. Setup only takes a few minutes. +We have written a thorough [step-by-step guide for PikaPods](/docs/install/pikapods). +However, if you are adventurous or somewhat technical, please go directly to the [Actual Budget setup in PikaPod](https://www.pikapods.com/pods?run=actual). + + +## I am technical and have no issues running a service on my own. + +Then you are in luck. We have guides for the following systems: + +* [Local installation](/docs/install/local) +* [Docker installation](/docs/install/docker) +* [Fly.io installation](/docs/install/fly) + +There is also an external guide explaining how to install Actual on: + +* [Synlogoy NAS](https://mariushosting.com/how-to-install-actual-on-your-synology-nas/) by Mariushosting. +* [Home Assistant](https://github.com/sztupy/hassio-actualbudget) by Zsolt Sz. Sztupák. + diff --git a/docs/index.md b/docs/index.md index 815ae1fcbf..8925d08eed 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,9 +8,13 @@ Welcome to Actual’s documentation! This page provides you a quick introduction ## Where to Begin? -If you’re new to Actual, [install](./install/index.md) it on a computer to start. After installation, check out the [Tour of Actual](./tour/index.md) for a -high-level overview of how Actual works. The next step is to read our [Starting Fresh](/docs/getting-started/starting-fresh) guide. Then we suggest dive into -the more detailed documentation, check out the “Using Actual” section from the left-nav of the Actual documentation. +If you're new to Actual, but do not know where to start, please consult the [roadmap for new users](/docs/getting-started/roadmap-for-new-users.md). + +You can also try to [install Actual](./install/index.md) on a computer to start. +After installation, check out the [Tour of Actual](./tour/index.md) for a +high-level overview of how Actual works. The next step is to read our +[Starting Fresh](/docs/getting-started/starting-fresh) guide. +Then we suggest dive into the more detailed documentation, check out the “Using Actual” section in the left menu. For help and support, [reach out to the maintainers and community](/contact).