From 73bf119409acdd474999fe9a513691da61bbe429 Mon Sep 17 00:00:00 2001 From: kolaente Date: Fri, 12 Apr 2024 23:39:27 +0200 Subject: [PATCH] docs: clarify version checkout when building from source Related to https://kolaente.dev/vikunja/vikunja/issues/2270#issuecomment-62038 --- docs/content/doc/setup/build-from-source.md | 1 + docs/content/doc/setup/install.md | 7 +++++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/content/doc/setup/build-from-source.md b/docs/content/doc/setup/build-from-source.md index 475ebadf0..a471d2c7c 100644 --- a/docs/content/doc/setup/build-from-source.md +++ b/docs/content/doc/setup/build-from-source.md @@ -18,6 +18,7 @@ To fully build Vikunja from source files, you need to build the api and frontend 1. Make sure you have git installed 2. Clone the repo with `git clone https://code.vikunja.io/vikunja` and switch into the directory. +3. Check out the version you want to build with `git checkout VERSION` - replace `VERSION` with the version want to use. If you don't do this, you'll build the [latest unstable build]({{< ref "versions.md">}}), which might contain bugs. ## Frontend diff --git a/docs/content/doc/setup/install.md b/docs/content/doc/setup/install.md index 1fb559658..bd5c4a624 100644 --- a/docs/content/doc/setup/install.md +++ b/docs/content/doc/setup/install.md @@ -225,10 +225,13 @@ go install github.com/magefile/mage ``` mkdir /mnt/GO/code.vikunja.io cd /mnt/GO/code.vikunja.io -git clone https://code.vikunja.io/api -cd /mnt/GO/code.vikunja.io/api +git clone https://code.vikunja.io/vikunja +cd vikunja ``` +**Note:** Ceck out the version you want to build with `git checkout VERSION` - replace `VERSION` with the version want to use. +If you don't do this, you'll build the [latest unstable build]({{< ref "versions.md">}}), which might contain bugs. + ### Compile binaries ```