diff --git a/docs/content/doc/development/development.md b/docs/content/doc/development/development.md index 158385fed..24edc6f70 100644 --- a/docs/content/doc/development/development.md +++ b/docs/content/doc/development/development.md @@ -1,5 +1,5 @@ --- -date: "2019-02-12:00:00+02:00" +date: "2022-09-21:00:00+02:00" title: "Development" toc: true draft: false @@ -42,8 +42,7 @@ You need to have [pnpm](https://pnpm.io/) and nodejs in version 16 or 18 install ## Git flow -The `main` branch is the latest and bleeding edge branch with all changes. Unstable releases are automatically -created from this branch. +The `main` branch is the latest and bleeding edge branch with all changes. Unstable releases are automatically created from this branch. A release gets tagged from the main branch with the version name as tag name. @@ -51,7 +50,6 @@ Backports and point-releases should go to a `release/version` branch, based on t ## Conventional commits -We're using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) because they greatly simplify -generating release notes. +We're using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) because they greatly simplify generating release notes. It is not required to use them when creating a PR, but appreciated. diff --git a/docs/content/doc/development/test.md b/docs/content/doc/development/test.md index 3e8c23b62..41437fa34 100644 --- a/docs/content/doc/development/test.md +++ b/docs/content/doc/development/test.md @@ -98,12 +98,12 @@ Check out the docs [in the frontend repo](https://kolaente.dev/vikunja/frontend/ To run the frontend unit tests, run {{< highlight bash >}} -pnpm test:unit +pnpm run test:unit {{< /highlight >}} The frontend also has a watcher available that re-runs all unit tests every time you change something. To use it, simply run {{< highlight bash >}} -pnpm test:unit-watch +pnpm run test:unit-watch {{< /highlight >}} diff --git a/docs/content/doc/setup/build-from-source.md b/docs/content/doc/setup/build-from-source.md index 0d0fa6103..282285363 100644 --- a/docs/content/doc/setup/build-from-source.md +++ b/docs/content/doc/setup/build-from-source.md @@ -1,5 +1,5 @@ --- -date: "2019-02-12:00:00+02:00" +date: "2022-09-21:00:00+02:00" title: "Build from sources" draft: false type: "doc" @@ -16,13 +16,13 @@ To completely build Vikunja from source, you need to build the api and frontend. ## API -The Vikunja API has no other dependencies than go itself. +The Vikunja API has no other dependencies than go itself. That means compiling it boils down to these steps: 1. Make sure [Go](https://golang.org/doc/install) is properly installed on your system. You'll need at least Go `1.17`. 2. Make sure [Mage](https://magefile.org) is properly installed on your system. 3. Clone the repo with `git clone https://code.vikunja.io/api` and switch into the directory. -3. Run `mage build:build` in the source of this repo. This will build a binary in the root of the repo which will be able to run on your system. +4. Run `mage build:build` in the source of this repo. This will build a binary in the root of the repo which will be able to run on your system. *Note:* Static ressources such as email templates are built into the binary. For these to work, you may need to run `mage build:generate` before building the vikunja binary. @@ -38,7 +38,7 @@ More options are available, please refer to the [magefile docs]({{< ref "../deve The code for the frontend is located at [code.vikunja.io/frontend](https://code.vikunja.io/frontend). -1. Make sure you have [pnpm](https://pnpm.io/) properly installed on your system. +1. Make sure you have [pnpm](https://pnpm.io/installation) properly installed on your system. 2. Clone the repo with `git clone https://code.vikunja.io/frontend` and switch into the directory. 3. Install all dependencies with `pnpm install` -4. Build the frontend with `pnpm build`. This will result in a static js bundle in the `dist/` folder which you can deploy. +4. Build the frontend with `pnpm run build`. This will result in a static js bundle in the `dist/` folder which you can deploy.