fix: shorter meta description
This commit is contained in:
parent
2ab717c811
commit
d8a0a097cd
@ -53,7 +53,7 @@ ${documentContent}
|
||||
|
||||
Carefully read and analyze the provided content. Identify the main topic, key points, and any relevant keywords. Based on your analysis, write a concise meta description that effectively summarizes the content and entices users to click through to the page.
|
||||
|
||||
Your meta description should be between 150-160 characters long, including spaces. This length is optimal for display in search engine results pages.
|
||||
Your meta description should be between 110 characters long, including spaces. This length is optimal for display in search engine results pages.
|
||||
|
||||
Provide your meta description inside <meta_description> tags. Do not include the character count or any other text outside these tags.
|
||||
|
||||
|
@ -3,9 +3,8 @@ title: Vikunja 0.13.0 is released
|
||||
date: 2020-05-12T12:00:00.000Z
|
||||
slug: /vikunja-0.13.0-is-released
|
||||
description: >-
|
||||
Discover Vikunja's latest release featuring Kanban boards, 2FA, and API
|
||||
improvements. Explore new task management capabilities and frontend
|
||||
enhancements for better productivity.
|
||||
Vikunja v0.13 release: Kanban boards, 2FA, API improvements, and frontend
|
||||
updates. Discover new features and enhancements for better task management.
|
||||
---
|
||||
|
||||
This is a big release!
|
||||
|
@ -3,9 +3,9 @@ title: Vikunja 0.14.0 is released
|
||||
date: 2020-07-01T12:00:00.000Z
|
||||
slug: /vikunja-0.14.0-is-released
|
||||
description: >-
|
||||
Discover Vikunja 0.14.0's new features: list backgrounds, todoist migration,
|
||||
task filters, and more. Explore improved UI, backup options, and repeating
|
||||
task enhancements for better productivity.
|
||||
Vikunja 0.14.0 release: List backgrounds, Todoist migration, task filters,
|
||||
namespace overview, and backup commands. Discover new features and
|
||||
improvements.
|
||||
---
|
||||
|
||||
This is (again?) a rather big release!
|
||||
|
@ -3,9 +3,9 @@ title: Vikunja 0.14.1 is released
|
||||
date: 2020-07-07T12:00:00.000Z
|
||||
slug: /vikunja-0.14.1-is-released
|
||||
description: >-
|
||||
Vikunja 0.14.1 release: API bugfixes and improvements. Download from the
|
||||
official page or Docker Hub. Includes fixes for list creation, user decoding,
|
||||
and Todoist import. Updated documentation theme.
|
||||
Bugfix release 0.14.1 for Vikunja API with improvements and fixes. Download
|
||||
from the official page or Docker Hub. Includes updates for list creation and
|
||||
user management.
|
||||
---
|
||||
|
||||
This is a smaller bugfix release with some improvements for the api.
|
||||
|
@ -3,9 +3,8 @@ title: Vikunja 0.15.0 is released
|
||||
date: 2020-10-19T12:00:00.000Z
|
||||
slug: /vikunja-0.15.0-is-released
|
||||
description: >-
|
||||
Discover Vikunja 0.15.0's new features: favorite lists and tasks, saved
|
||||
filters, user management via CLI, keyboard shortcuts, and desktop app. Upgrade
|
||||
now for enhanced productivity.
|
||||
Vikunja 0.15.0 release: Favorite lists & tasks, saved filters, user management
|
||||
via CLI, keyboard shortcuts, and desktop app. Explore new features now!
|
||||
---
|
||||
|
||||
Long time no release! This is again a rather big release (I feel like I'm writing that way too often).
|
||||
|
@ -3,9 +3,8 @@ title: '[API] Vikunja 0.15.1 is released'
|
||||
date: 2020-10-20T12:00:00.000Z
|
||||
slug: /api-vikunja-0.15.1-is-released
|
||||
description: >-
|
||||
Quick fix for Vikunja API bug: Resolves issue with creating new tasks when
|
||||
metrics are enabled. Download the latest release or Docker image for improved
|
||||
functionality.
|
||||
Discover the latest Vikunja update: A quick fix for task creation with metrics
|
||||
enabled. Download from our page or Docker Hub now.
|
||||
---
|
||||
|
||||
This is a quick fix for a bug which prevented creating new tasks when metrics were enabled.
|
||||
|
@ -3,9 +3,8 @@ title: Vikunja 0.16.0 is released
|
||||
date: 2021-01-10T12:00:00.000Z
|
||||
slug: /vikunja-0.16.0-is-released
|
||||
description: >-
|
||||
Discover Vikunja 0.16.0: New desktop app, enhanced filters, Microsoft To-Do
|
||||
and Trello migration, email reminders, and OpenID Connect support. Upgrade now
|
||||
for improved task management.
|
||||
Discover new features in Vikunja 0.16.0: desktop app, enhanced filters,
|
||||
Microsoft To-Do and Trello migration, email reminders, and more. Upgrade now!
|
||||
---
|
||||
|
||||
New year, new Vikunja version (I know I know, I'm two weeks late).
|
||||
|
@ -3,8 +3,8 @@ title: '[API] Vikunja 0.16.1 is released'
|
||||
date: 2021-04-22T12:00:00.000Z
|
||||
slug: /api-vikunja-0.16.1-is-released
|
||||
description: >-
|
||||
Security update for Vikunja API v0.16.1 now available. Download the latest
|
||||
release or access via Docker Hub for enhanced protection. Upgrade recommended.
|
||||
Security release for Vikunja API 0.16.1 now available. Upgrade recommended.
|
||||
Download from official page or Docker Hub for enhanced protection.
|
||||
---
|
||||
|
||||
This is a security release. Upgrading is highly encouraged.
|
||||
|
@ -3,9 +3,8 @@ title: Vikunja 0.17.0 is released
|
||||
date: 2021-05-11T19:00:00.000Z
|
||||
slug: /vikunja-0.17.0-is-released
|
||||
description: >-
|
||||
Discover Vikunja 0.17.0's new features: redesigned frontend, notifications,
|
||||
link share enhancements, email reminders, and improved Kanban boards. Upgrade
|
||||
now for a better task management experience.
|
||||
Vikunja 0.17.0 release: New frontend design, notifications, link share
|
||||
enhancements, and more. Discover improved task management features.
|
||||
---
|
||||
|
||||
I'm proud to announce Vikunja 0.17.0!
|
||||
|
@ -4,8 +4,7 @@ title: '[API] Vikunja 0.17.1 is released'
|
||||
slug: /api-vikunja-0.17.1-is-released
|
||||
description: >-
|
||||
Vikunja 0.17.1 patch release fixes openid config parsing with JSON files.
|
||||
Download the latest API update from the official page or Docker Hub for
|
||||
improved functionality.
|
||||
Download from official page or Docker Hub for improved functionality.
|
||||
---
|
||||
|
||||
This is a small patch release which fixes parsing openid config when using a json config file.
|
||||
|
@ -3,9 +3,9 @@ title: What's new in Vikunja 0.18.0
|
||||
date: 2021-09-05T14:37:58.000Z
|
||||
slug: /whats-new-in-vikunja-0.18.0
|
||||
description: >-
|
||||
Discover Vikunja 0.18.0: Quick Add Magic, global search, task reordering, and
|
||||
more languages. Explore new features like user data export/import and enhanced
|
||||
security. Download now!
|
||||
Vikunja 0.18.0 release: Quick Add Magic, global search, task reordering, and
|
||||
more languages. Explore new features and security improvements for this task
|
||||
management tool.
|
||||
---
|
||||
|
||||
I'm proud to announce Vikunja 0.18.0!
|
||||
|
@ -3,9 +3,8 @@ title: Vikunja 0.18.1 is released
|
||||
date: 2021-09-08T17:50:26.000Z
|
||||
slug: /vikunja-0.18.1-is-released
|
||||
description: >-
|
||||
Vikunja patch release v0.18.1 fixes bugs in user data export, kanban board,
|
||||
and repeating tasks. Upgrade available for API, frontend, and desktop. Check
|
||||
changelogs and update instructions.
|
||||
Vikunja patch release v0.18.1 fixes user data export, kanban board, and
|
||||
repeating tasks issues. Update API, frontend, and desktop components easily.
|
||||
---
|
||||
|
||||
This is a quick patch release fixing bugs with the user data export, the kanban board and saving repeating tasks attributes.
|
||||
|
@ -3,9 +3,9 @@ title: Vikunja 0.18.2 is released
|
||||
date: 2021-11-23T19:18:54.000Z
|
||||
slug: /vikunja-0.18.2-is-released
|
||||
description: >-
|
||||
Vikunja patch release 0.18.2 fixes bugs with saved filter renaming and API URL
|
||||
setting. Includes frontend and desktop updates. See changelog and upgrade
|
||||
instructions for details.
|
||||
Vikunja patch release v0.18.2 fixes bugs with saved filter renaming and API
|
||||
URL setting. Update frontend and desktop components via file replacement or
|
||||
Docker image.
|
||||
---
|
||||
|
||||
This is a quick patch release fixing bugs with renaming a saved filter and correctly setting the api url via env url in the docker image.
|
||||
|
@ -3,9 +3,9 @@ title: What's new in Vikunja 0.19.0
|
||||
date: 2022-08-03T18:37:08.000Z
|
||||
slug: /whats-new-in-vikunja-0.19.0
|
||||
description: >-
|
||||
Discover Vikunja 0.19.0, the open-source to-do app with dark mode, mobile app,
|
||||
and improved login. Explore new features like CalDAV tokens, date math
|
||||
filters, and checklist indicators.
|
||||
Vikunja 0.19.0 release: New features include dark mode, mobile app updates,
|
||||
task reminders, and CalDAV tokens. Discover the latest enhancements for this
|
||||
open-source to-do app.
|
||||
---
|
||||
|
||||
I'm proud to announce Vikunja 0.19.0!
|
||||
|
@ -3,9 +3,8 @@ title: Vikunja 0.19.1 is released
|
||||
date: 2022-08-17T08:23:07.000Z
|
||||
slug: /vikunja-0.19.1-is-released
|
||||
description: >-
|
||||
Vikunja v0.19.1 patch release: Frontend and API fixes, improved dark mode,
|
||||
arm32 support, and search enhancements. One breaking change for assignee
|
||||
filtering. Upgrade instructions included.
|
||||
Vikunja v0.19.1 patch release: UI improvements, API fixes, and Docker support
|
||||
for Raspberry Pi. Includes breaking change for assignee filtering.
|
||||
---
|
||||
|
||||
This is a patch release with fixes in the frontend and api.
|
||||
|
@ -4,8 +4,7 @@ date: 2022-08-17T15:06:09.000Z
|
||||
slug: /api-vikunja-0.19.2-is-released
|
||||
description: >-
|
||||
Critical bug fix for Vikunja API v0.19.2. Resolves issue with saved filters.
|
||||
Urgent update recommended. Download latest binary or Docker image for
|
||||
immediate upgrade.
|
||||
Upgrade recommended. Download latest binary or Docker image.
|
||||
---
|
||||
|
||||
This release fixes a critical bug which was introduced in the api in 0.19.1.
|
||||
|
@ -3,9 +3,9 @@ title: What's new in Vikunja 0.20.0
|
||||
date: 2022-10-28T10:28:44.000Z
|
||||
slug: /whats-new-in-vikunja-0.20.0
|
||||
description: >-
|
||||
Discover Vikunja 0.20.0, the open-source to-do app with enhanced features like
|
||||
Gantt chart improvements, task cover images, and TickTick import. Learn about
|
||||
new updates and try it now!
|
||||
Discover Vikunja 0.20.0: The open-source to-do app with new features like
|
||||
Gantt chart improvements, enhanced link shares, and task cover images.
|
||||
Organize better!
|
||||
---
|
||||
|
||||
I'm proud to announce Vikunja 0.20.0!
|
||||
|
@ -4,8 +4,7 @@ date: 2022-11-11T11:05:34.000Z
|
||||
slug: /vikunja-0.20.1-was-released
|
||||
description: >-
|
||||
Vikunja v0.20.1 patch release: Important fixes for database connections, date
|
||||
filtering, and task management. Includes frontend and API updates. Learn about
|
||||
key changes and upgrade instructions.
|
||||
filtering, and task sorting. Includes frontend and API improvements.
|
||||
---
|
||||
|
||||
This is a patch release with important fixes and refactorings in the frontend and api.
|
||||
|
@ -3,9 +3,8 @@ title: Vikunja Frontend 0.20.2 was released
|
||||
date: 2022-12-18T11:11:35.000Z
|
||||
slug: /vikunja-frontend-0.20.2-was-released
|
||||
description: >-
|
||||
Discover key updates in Vikunja's frontend patch release 0.20.2, including bug
|
||||
fixes, UI improvements, and performance enhancements. Learn how to upgrade
|
||||
your installation.
|
||||
Vikunja frontend patch 0.20.2: Bug fixes, UI improvements, and performance
|
||||
enhancements. Includes error resolution and new features for task management.
|
||||
---
|
||||
|
||||
This is a patch release with important fixes and improvements in the frontend.
|
||||
|
@ -3,9 +3,9 @@ title: Vikunja frontend v0.20.3 and API v0.20.2 was released
|
||||
date: 2023-01-24T16:20:21.000Z
|
||||
slug: /vikunja-frontend-v0.20.3-and-api-v0.20.2-was-released
|
||||
description: >-
|
||||
Vikunja 0.20.3 patch release: Improved Todoist migration, fixed overdue
|
||||
reminders, new Norwegian language option. Upgrade now for better task
|
||||
management features.
|
||||
Vikunja 0.20.3 patch release: Improved Todoist sync, migration fixes, overdue
|
||||
reminder fix, and new Norwegian language support. Upgrade now for enhanced
|
||||
task management.
|
||||
---
|
||||
|
||||
This is a patch release with important fixes and improvements in the frontend and api.
|
||||
|
@ -3,9 +3,8 @@ title: Vikunja frontend v0.20.4 and API v0.20.3 was released
|
||||
date: 2023-03-10T13:58:56.000Z
|
||||
slug: /vikunja-frontend-v0.20.4-and-api-v0.20.3-was-released
|
||||
description: >-
|
||||
Vikunja 0.20.4 patch release: Important fixes for frontend and API, including
|
||||
improved Docker images, migration fixes, and Kanban board enhancements. New
|
||||
Helm Chart available.
|
||||
Vikunja 0.20.4 patch release: Key fixes for frontend and API, improved Docker
|
||||
images, migration updates, and new official Helm Chart for k8s deployment.
|
||||
---
|
||||
|
||||
This is a patch release with important fixes and improvements in the frontend and api.
|
||||
|
@ -3,9 +3,8 @@ title: Vikunja frontend v0.20.5 and API v0.20.4 was released
|
||||
date: 2023-03-12T09:25:18.000Z
|
||||
slug: /vikunja-frontend-v0.20.5-and-api-v0.20.4-was-released
|
||||
description: >-
|
||||
Patch release for Vikunja: Fixes docker image issues for frontend and API
|
||||
containers. Includes changelogs and upgrade instructions for improved
|
||||
functionality.
|
||||
Vikunja patch release 0.20.5 fixes Docker image issues. Upgrade frontend and
|
||||
API for improved container compatibility. Check changelogs and update docs.
|
||||
---
|
||||
|
||||
This is a patch release which fixes a problem with the last release's docker images.
|
||||
|
@ -3,9 +3,8 @@ title: What's new in Vikunja 0.21.0
|
||||
date: 2023-07-07T14:11:10.000Z
|
||||
slug: /whats-new-in-vikunja-0.21.0
|
||||
description: >-
|
||||
Discover Vikunja 0.21.0, the open-source to-do app with new features like
|
||||
Projects, Relative Reminders, and improved Assignee Search. Organize tasks
|
||||
effortlessly with this self-hostable solution.
|
||||
Vikunja 0.21.0 release: Lists and Namespaces become Projects, relative
|
||||
reminders added, improved assignee search, and frontend settings enhancements.
|
||||
---
|
||||
|
||||
I'm proud to announce Vikunja 0.21.0!
|
||||
|
@ -3,9 +3,9 @@ title: What's new in Vikunja 0.22.0
|
||||
date: 2023-12-19T15:24:51.000Z
|
||||
slug: /whats-new-in-vikunja-0.22.0
|
||||
description: >-
|
||||
Discover Vikunja 0.22.0: The open-source to-do app with new API tokens,
|
||||
webhooks, n8n integration, improved editor, and Typesense search support.
|
||||
Organize tasks effortlessly.
|
||||
Vikunja 0.22.0 release: New features include API tokens, webhooks, n8n
|
||||
integration, improved editor, and Typesense search support for the open-source
|
||||
to-do app.
|
||||
---
|
||||
|
||||
I'm proud to announce Vikunja 0.22.0!
|
||||
|
@ -3,9 +3,9 @@ title: Vikunja frontend and API v0.22.1 was released
|
||||
date: 2024-01-28T18:53:14.000Z
|
||||
slug: /vikunja-frontend-and-api-v0.22.1-was-released
|
||||
description: >-
|
||||
Discover the latest updates in Vikunja's patch release, featuring bug fixes,
|
||||
new features, and performance improvements. Learn about datepicker
|
||||
enhancements and task reminder updates.
|
||||
Discover Vikunja's latest patch release: new features, bug fixes, and
|
||||
performance improvements. Learn about user locale datepicker, task reminders,
|
||||
and more.
|
||||
---
|
||||
|
||||
This is a patch release with many small bug fixes and improvements.
|
||||
|
@ -3,9 +3,9 @@ title: What's new in Vikunja 0.23.0
|
||||
date: 2024-02-10T13:26:30.000Z
|
||||
slug: /whats-new-in-vikunja-0.23.0
|
||||
description: >-
|
||||
Vikunja 0.23.0 release: API, frontend, and desktop now merged into one repo.
|
||||
Learn about simplified deployment, configuration changes, and upgrade
|
||||
instructions for this open-source to-do app.
|
||||
Vikunja 0.23.0 release: API, frontend, and desktop now merged. Learn about
|
||||
upgrade steps, configuration changes, and simplified deployment for this
|
||||
open-source to-do app.
|
||||
---
|
||||
|
||||
I'm happy to announce Vikunja 0.23.0!
|
||||
|
@ -4,8 +4,8 @@ date: 2024-07-02T16:00:00.000Z
|
||||
slug: /whats-new-in-vikunja-0.24.0
|
||||
description: >-
|
||||
Vikunja 0.24.0 release: New customizable views, improved filters, emoji
|
||||
reactions, and OpenID team integration. Discover enhanced project management
|
||||
features and UI updates.
|
||||
reactions, and more. Discover enhanced project management features and UI
|
||||
updates.
|
||||
---
|
||||
|
||||
Long time no see!
|
||||
|
@ -3,9 +3,9 @@ title: Vikunja v0.24.1 was released
|
||||
date: 2024-07-18T16:00:00.000Z
|
||||
slug: /vikunja-v0.24.1-was-released
|
||||
description: >-
|
||||
Discover the latest updates in Vikunja 0.24.1: improved filters, enhanced
|
||||
Kanban view, bug fixes, and performance upgrades. Learn about new features and
|
||||
how to upgrade.
|
||||
Vikunja 0.24.1 patch release: Bug fixes, improved filters, Kanban view
|
||||
enhancements, and UI updates. Upgrade now for a smoother task management
|
||||
experience.
|
||||
---
|
||||
|
||||
Following the release of 0.24.0 almost two weeks ago, this is a patch release with many small bug fixes and
|
||||
|
@ -3,9 +3,8 @@ title: Vikunja v0.24.2 was released
|
||||
date: 2024-08-12T19:00:00.000Z
|
||||
slug: /vikunja-v0.24.2-was-released
|
||||
description: >-
|
||||
Discover the latest improvements in Vikunja 0.24.2. This patch update brings
|
||||
bug fixes for tasks, views, and migration, along with performance enhancements
|
||||
for a smoother project management experience.
|
||||
Vikunja 0.24.2 release: Bug fixes for tasks, views, and migration. Performance
|
||||
improvements for projects and labels. Upgrade now for a smoother experience.
|
||||
---
|
||||
|
||||
Following the recent release of Vikunja 0.24.1, we're happy to announce the release of Vikunja 0.24.2, a patch update
|
||||
|
@ -3,9 +3,9 @@ title: Vikunja v0.24.3 was released
|
||||
date: 2024-09-20T19:00:00.000Z
|
||||
slug: /vikunja-v0.24.3-was-released
|
||||
description: >-
|
||||
Discover the latest updates in Vikunja 0.24.3! Learn about fixes and
|
||||
improvements for auth, CalDAV, filters, Kanban, projects, reminders, tasks,
|
||||
and more. Upgrade now for enhanced functionality.
|
||||
Discover the latest improvements in Vikunja 0.24.3: bug fixes, enhanced
|
||||
filters, Kanban updates, and more. Upgrade now for a better task management
|
||||
experience.
|
||||
---
|
||||
|
||||
I'm excited to announce the release of Vikunja 0.24.3! This update brings a whole bunch of fixes and improvements to Vikunja.
|
||||
|
@ -3,9 +3,8 @@ title: 'Vikunja 0.24.4: Enhancing Stability and User Experience'
|
||||
date: 2024-09-29T19:00:00.000Z
|
||||
slug: /vikunja-v0.24.4-was-released
|
||||
description: >-
|
||||
Discover Vikunja 0.24.4: Latest patch update enhances task management with
|
||||
improved stability, bug fixes, and user experience refinements. Upgrade now
|
||||
for smoother productivity.
|
||||
Vikunja 0.24.4 update: Improved task management, bug fixes, and enhanced user
|
||||
experience. Discover key improvements for smoother productivity.
|
||||
---
|
||||
|
||||
I'm excited to announce the release of Vikunja 0.24.4, the latest patch update focused on improving stability, fixing
|
||||
|
@ -2,9 +2,9 @@
|
||||
title: Adding new cli commands
|
||||
slug: cli-commands
|
||||
description: >-
|
||||
Learn how to add CLI commands to Vikunja using the Cobra library. Explore the
|
||||
structure of CLI functions, command implementation, and best practices for
|
||||
extending Vikunja's command-line interface.
|
||||
Learn how to add CLI commands in Vikunja using the Cobra library. Discover the
|
||||
structure and best practices for implementing new command-line
|
||||
functionalities.
|
||||
---
|
||||
|
||||
All cli-related functions are located in `pkg/cmd`.
|
||||
|
@ -2,9 +2,9 @@
|
||||
title: Configuration Options
|
||||
slug: configuration-options
|
||||
description: >-
|
||||
Learn how to manage configuration in Go projects using Viper. Discover best
|
||||
practices for adding new options, setting defaults, and retrieving values in
|
||||
your code efficiently.
|
||||
Learn how to add and manage configuration options in Go projects using Viper.
|
||||
Discover best practices for declaring variables, setting defaults, and
|
||||
retrieving values.
|
||||
---
|
||||
|
||||
All configuration variables are declared in the `config` package.
|
||||
|
@ -2,9 +2,9 @@
|
||||
title: How to add a cron job task
|
||||
slug: cron-tasks
|
||||
description: >-
|
||||
Learn how to implement cron jobs in Vikunja using the robfig/cron package.
|
||||
Discover schedule syntax, task registration, and best practices for automated
|
||||
task execution in Go.
|
||||
Learn how to implement cron jobs in Vikunja using the github.com/robfig/cron
|
||||
package. Discover syntax, scheduling, and task registration for automated task
|
||||
execution.
|
||||
---
|
||||
|
||||
Cron jobs are tasks which run on a predefined schedule.
|
||||
|
@ -2,9 +2,8 @@
|
||||
title: Database
|
||||
slug: database
|
||||
description: >-
|
||||
Learn how to use xorm for database operations in Vikunja, including creating
|
||||
tables, adding migrations, and managing test fixtures. Essential guide for
|
||||
developers working with Vikunja's database layer.
|
||||
Learn how to use xorm with Vikunja for database management, including adding
|
||||
tables, creating migrations, and setting up test fixtures using YAML files.
|
||||
---
|
||||
|
||||
Vikunja uses [xorm](https://xorm.io/) as an abstraction layer to handle the database connection.
|
||||
|
@ -3,8 +3,8 @@ title: Database Migrations
|
||||
slug: database-migrations
|
||||
description: >-
|
||||
Learn how to manage database migrations in Vikunja, including automatic
|
||||
execution, adding new migrations, and generating migration stubs. Discover
|
||||
best practices for Vikunja development.
|
||||
updates, adding new migrations, and generating migration stubs. Explore best
|
||||
practices for developers.
|
||||
---
|
||||
|
||||
Vikunja runs all database migrations automatically on each start if needed.
|
||||
|
@ -2,9 +2,9 @@
|
||||
title: Development
|
||||
slug: development
|
||||
description: >-
|
||||
Learn how to contribute to Vikunja, an open-source project management tool.
|
||||
Guidelines for submitting pull requests, filing issues, and developing for API
|
||||
and frontend. Join the community and help improve Vikunja.
|
||||
Learn how to contribute to Vikunja: fork the project, make changes, and submit
|
||||
pull requests. Guidelines for API, frontend development, and best practices
|
||||
for faster reviews.
|
||||
---
|
||||
|
||||
## General
|
||||
|
@ -2,9 +2,8 @@
|
||||
title: Custom Errors
|
||||
slug: custom-errors
|
||||
description: >-
|
||||
Learn how to define and implement custom errors in Vikunja's Go codebase.
|
||||
Includes guidelines for creating error structs, functions, and HTTP error
|
||||
responses with unique error codes.
|
||||
Learn how to define and implement custom errors in Vikunja, including error
|
||||
structs, functions, and HTTP error handling. Improve your Go error management.
|
||||
---
|
||||
|
||||
All custom errors are defined in `pkg/models/errors.go`.
|
||||
|
@ -3,8 +3,8 @@ title: Events and Listeners
|
||||
slug: events-and-listeners
|
||||
description: >-
|
||||
Learn about Vikunja's event system: how to create, dispatch, and listen for
|
||||
events using Go channels. Discover best practices for implementing the
|
||||
observer pattern in your projects.
|
||||
events using Go channels. Includes guidelines for naming conventions and
|
||||
testing.
|
||||
---
|
||||
|
||||
Vikunja provides a simple observer pattern mechanism through events and listeners.
|
||||
|
@ -2,9 +2,8 @@
|
||||
title: Add a new api endpoint/feature
|
||||
slug: new-api-endpoints
|
||||
description: >-
|
||||
Learn about Vikunja's common web handler for creating REST endpoints,
|
||||
including CRUD request handling, rights checks, and pagination. Explore API
|
||||
features and development tools.
|
||||
Learn about Vikunja's API endpoints, common web handler, and pagination
|
||||
helpers for creating REST endpoints and managing CRUD requests efficiently.
|
||||
---
|
||||
|
||||
Most of the api endpoints/features of Vikunja are using the [common web handler](https://code.vikunja.io/web).
|
||||
|
@ -2,9 +2,8 @@
|
||||
title: Magefile
|
||||
slug: magefile
|
||||
description: >-
|
||||
Discover how to use Mage for Vikunja development tasks. Learn about build,
|
||||
check, release, test, and dev commands. Streamline your workflow with this
|
||||
comprehensive guide to Magefile usage.
|
||||
Explore Vikunja's Magefile tasks for building, testing, and releasing. Learn
|
||||
how to use Mage for efficient Go development workflows.
|
||||
---
|
||||
|
||||
Vikunja uses [Mage](https://magefile.org/) to script common development tasks and even releasing.
|
||||
|
@ -2,9 +2,9 @@
|
||||
title: Metrics
|
||||
slug: metrics
|
||||
description: >-
|
||||
Learn how to expose and manage metrics in Vikunja using Prometheus and Redis.
|
||||
This guide covers creating, updating, and registering custom metrics for
|
||||
efficient monitoring.
|
||||
Learn how to expose and update metrics in Vikunja using Prometheus and Redis.
|
||||
Discover the process of registering new metrics and managing their values
|
||||
efficiently.
|
||||
---
|
||||
|
||||
Metrics work by exposing a `/metrics` endpoint which can then be accessed by prometheus.
|
||||
|
@ -2,9 +2,9 @@
|
||||
title: Writing a migrator for Vikunja
|
||||
slug: migrations
|
||||
description: >-
|
||||
Learn how to migrate data to Vikunja from other to-do services. Discover
|
||||
implementation methods, interfaces, and helper tools for seamless task
|
||||
migration and integration.
|
||||
Learn how to migrate data to Vikunja using auth-based or file migration
|
||||
methods. Implement migrator interfaces, define routes, and use helper methods
|
||||
for seamless integration.
|
||||
---
|
||||
|
||||
It is possible to migrate data from other to-do services to Vikunja.
|
||||
|
@ -2,9 +2,9 @@
|
||||
title: Notifications
|
||||
slug: notifications
|
||||
description: >-
|
||||
Learn how to create and send notifications in Vikunja using mail and database
|
||||
methods. Discover implementation, customization, and testing techniques for
|
||||
effective user communication.
|
||||
Learn how to implement and send notifications in Vikunja, including mail and
|
||||
database notifications, creating custom notifications, and testing best
|
||||
practices.
|
||||
---
|
||||
|
||||
Vikunja provides a simple abstraction to send notifications per mail and in the database.
|
||||
|
@ -2,9 +2,8 @@
|
||||
title: Releasing a new Vikunja version
|
||||
slug: releasing-a-new-vikunja-version
|
||||
description: >-
|
||||
Comprehensive release checklist for Vikunja updates. Includes steps for
|
||||
website updates, changelogs, tagging versions, package updates, blog posts,
|
||||
and promotional activities.
|
||||
Comprehensive release checklist for Vikunja: Website updates, changelogs,
|
||||
tagging, package updates, blog posts, and promotion across platforms.
|
||||
---
|
||||
|
||||
This checklist is a collection of all steps usually involved when releasing a new version of Vikunja.
|
||||
|
@ -2,9 +2,9 @@
|
||||
title: Project Structure
|
||||
slug: project-structure
|
||||
description: >-
|
||||
Explore Vikunja's package structure and learn about key components like
|
||||
caldav, config, models, and routes. Discover how to add features, handle
|
||||
migrations, and work with the API.
|
||||
Explore Vikunja's package structure: Learn about core components, API
|
||||
endpoints, database handling, and more. Dive into the architecture of this
|
||||
powerful task management system.
|
||||
---
|
||||
|
||||
This document explains what each package does.
|
||||
|
@ -3,8 +3,8 @@ title: Modifying Swagger API Docs
|
||||
slug: modifying-swagger-api-docs
|
||||
description: >-
|
||||
Learn how to document structs and API endpoints in Go using Swaggo. Improve
|
||||
your API documentation with clear comments and generate comprehensive Swagger
|
||||
docs for better developer experience.
|
||||
your API documentation with clear comments and structured annotations for
|
||||
better developer experience.
|
||||
---
|
||||
|
||||
The api documentation is generated using [swaggo](https://github.com/swaggo/swag) from comments.
|
||||
|
@ -2,9 +2,9 @@
|
||||
title: Testing
|
||||
slug: testing
|
||||
description: >-
|
||||
Learn how to run API, frontend, and integration tests for Vikunja. Explore
|
||||
unit tests, fixtures, config options, and Cypress end-to-end tests. Improve
|
||||
your development workflow with comprehensive testing guidelines.
|
||||
Learn about API and frontend testing in Vikunja. Explore unit tests,
|
||||
integration tests, fixtures, and configuration options for both backend and
|
||||
frontend development.
|
||||
---
|
||||
|
||||
## API Tests
|
||||
|
@ -3,9 +3,9 @@ title: German Translation Instructions
|
||||
slug: german-translation-instructions
|
||||
hideInMenu: true
|
||||
description: >-
|
||||
Guidelines for German translation of Vikunja: informal tone, gender-neutral
|
||||
language, specific terminology, and correct formatting. Includes tips for
|
||||
buttons, modals, and word choices.
|
||||
Richtlinien für die deutsche Übersetzung von Vikunja: Anrede, Formulierungen,
|
||||
Gendern und Wortverwendung. Tipps für konsistente und benutzerfreundliche
|
||||
Lokalisierung.
|
||||
---
|
||||
|
||||
{% callout type="warning" %}
|
||||
|
@ -2,9 +2,9 @@
|
||||
title: Translations
|
||||
slug: translations
|
||||
description: >-
|
||||
Learn how to translate Vikunja's frontend using Crowdin. Find guidelines for
|
||||
translating, adding new strings, and requesting languages. Contribute to
|
||||
making Vikunja accessible in multiple languages.
|
||||
Learn how to translate Vikunja using Crowdin. Guidelines for translators,
|
||||
language-specific instructions, and process for adding new languages and
|
||||
translation strings.
|
||||
---
|
||||
|
||||
This document provides documentation about how to translate Vikunja.
|
||||
|
@ -2,9 +2,8 @@
|
||||
title: What to backup
|
||||
slug: what-to-backup
|
||||
description: >-
|
||||
Learn how to back up Vkunja data, including database and attachment files.
|
||||
Step-by-step instructions for MySQL, PostgreSQL, and SQLite backups and
|
||||
restorations are provided.
|
||||
Learn how to backup and restore Vkunja databases and files for MySQL,
|
||||
PostgreSQL, and SQLite. Step-by-step guide for data protection and recovery.
|
||||
---
|
||||
|
||||
There are two parts you need to back up: The database and attachment files.
|
||||
|
@ -3,8 +3,8 @@ title: Build Vikunja from sources
|
||||
slug: build-from-sources
|
||||
description: >-
|
||||
Learn how to build Vikunja from source, including frontend and API.
|
||||
Step-by-step guide for compiling the task management tool on various platforms
|
||||
using Go, pnpm, and Mage.
|
||||
Step-by-step guide for compiling and deploying this open-source task
|
||||
management tool.
|
||||
---
|
||||
|
||||
To fully build Vikunja from source files, you need to build the api and frontend.
|
||||
|
@ -3,8 +3,8 @@ title: Configuration options
|
||||
slug: config-options
|
||||
description: >-
|
||||
Learn how to configure Vikunja using config files or environment variables.
|
||||
Explore supported formats, file locations, and default settings for optimal
|
||||
setup and customization of your Vikunja instance.
|
||||
Discover supported formats, file locations, and default settings for optimal
|
||||
setup.
|
||||
---
|
||||
|
||||
You can either use a `config.yml` file in the root directory of Vikunja or set almost all config option with environment variables. If you have both, the value set in the config file is used.
|
||||
|
@ -3,8 +3,7 @@ title: Desktop Packages
|
||||
slug: desktop-packages
|
||||
description: >-
|
||||
Learn how to install Vikunja's desktop app for Linux and Windows. Download
|
||||
options for various OS, plus Flatpak installation guide. Get Vikunja on your
|
||||
desktop today!
|
||||
options, installation steps, and Flatpak instructions included.
|
||||
---
|
||||
|
||||
Vikunja is available as an electron-based desktop application for Linux and Windows.
|
||||
|
@ -3,8 +3,7 @@ title: Docker Walkthrough
|
||||
slug: docker-walkthrough
|
||||
description: >-
|
||||
Learn how to set up Vikunja using Docker Compose. This beginner-friendly guide
|
||||
covers installation, configuration, and troubleshooting for quick deployment
|
||||
of the task management system.
|
||||
covers installation, configuration, and troubleshooting for quick deployment.
|
||||
---
|
||||
|
||||
This tutorial assumes basic knowledge of docker.
|
||||
|
@ -2,9 +2,9 @@
|
||||
title: Full docker example
|
||||
slug: full-docker-example
|
||||
description: >-
|
||||
Learn how to deploy Vikunja using Docker Compose with various configurations
|
||||
including MariaDB, PostgreSQL, SQLite, and proxy setups. Includes examples for
|
||||
Traefik, Caddy, and Synology NAS.
|
||||
Learn how to deploy Vikunja using Docker Compose with various database options
|
||||
and proxy configurations. Includes examples for Traefik, Caddy, and Synology
|
||||
NAS setups.
|
||||
---
|
||||
|
||||
This docker compose configuration will run Vikunja with a mariadb database.
|
||||
|
@ -3,8 +3,8 @@ title: Installing
|
||||
slug: installing
|
||||
description: >-
|
||||
Learn how to install Vikunja, the open-source task management tool. Explore
|
||||
various installation methods including binary, Docker, Debian, RPM, and
|
||||
FreeBSD. Find configuration options and setup guides.
|
||||
various methods including binary, Docker, and package managers for different
|
||||
platforms.
|
||||
---
|
||||
|
||||
Architecturally, Vikunja is made up of two parts: [API](https://code.vikunja.io/vikunja)
|
||||
|
@ -3,8 +3,8 @@ title: Hosting Vikunja with k8s
|
||||
slug: hosting-vikunja-with-k8s
|
||||
description: >-
|
||||
Discover official and third-party Helm Charts for deploying Vikunja on
|
||||
Kubernetes. Learn about options from Truecharts and k8s at Home for efficient
|
||||
containerized management.
|
||||
Kubernetes. Learn about options from Truecharts and k8s at Home for easy
|
||||
installation.
|
||||
---
|
||||
|
||||
We have an official Helm Chart for Vikunja.
|
||||
|
@ -2,9 +2,8 @@
|
||||
title: Metrics
|
||||
slug: metrics-setup
|
||||
description: >-
|
||||
Learn how to set up metrics for Vikunja using Grafana and Prometheus. This
|
||||
guide covers Prometheus configuration for scraping metrics and importing a
|
||||
Grafana dashboard for monitoring.
|
||||
Learn how to set up metrics for Vikunja using Grafana and Prometheus. Includes
|
||||
sample Prometheus config and Grafana dashboard import instructions.
|
||||
---
|
||||
|
||||
This page describes how to set up metrics for Vikunja using Grafana and Prometheus.
|
||||
|
@ -2,9 +2,9 @@
|
||||
title: Migration from third-party services
|
||||
slug: migration-from-third-party-services
|
||||
description: >-
|
||||
Learn how to migrate data from third-party services to Vikunja. Step-by-step
|
||||
guide for setting up and starting the migration process, with tips for
|
||||
troubleshooting and adding new options.
|
||||
Learn how to migrate data from third-party services to Vikunja. Follow
|
||||
step-by-step instructions for setup, configuration, and starting the migration
|
||||
process.
|
||||
---
|
||||
|
||||
There are several importers available for third-party services like Trello, Microsoft To Do or Todoist.
|
||||
|
@ -3,8 +3,7 @@ title: OpenID example configurations
|
||||
slug: openid-example-configurations
|
||||
description: >-
|
||||
Learn how to set up Vikunja with OAuth 2.0 providers using OpenID Connect.
|
||||
Examples include Authelia, Google, Keycloak, Authentik, and Azure AD.
|
||||
Step-by-step configurations provided.
|
||||
Examples for Authelia, Google, Keycloak, Authentik, and Azure AD included.
|
||||
---
|
||||
|
||||
On this page you will find examples about how to set up Vikunja with a third-party OAuth 2.0 provider using OpenID Connect.
|
||||
|
@ -3,8 +3,7 @@ title: OpenID
|
||||
slug: openid
|
||||
description: >-
|
||||
Learn how to set up OpenID Connect authentication in Vikunja, including
|
||||
configuring providers, required claims, and automatic team assignment for
|
||||
seamless user management.
|
||||
configuring providers, required claims, and automatic team assignment.
|
||||
---
|
||||
|
||||
Vikunja allows for authentication with an external identity source such as Authentik, Keycloak or similar via the
|
||||
|
@ -2,9 +2,9 @@
|
||||
title: Setup behind a reverse proxy
|
||||
slug: reverse-proxy
|
||||
description: >-
|
||||
Learn how to configure Vikunja with popular web servers like NGINX, Apache,
|
||||
and Caddy. This guide covers proxy settings, SSL, and Docker integration for
|
||||
seamless deployment.
|
||||
Learn how to configure reverse proxies for Vikunja using NGINX, NGINX Proxy
|
||||
Manager, Apache, and Caddy. Step-by-step instructions for secure setup and
|
||||
HTTPS support.
|
||||
---
|
||||
|
||||
These examples assume you have an instance of Vikunja running on your server listening on port `3456`.
|
||||
|
@ -3,8 +3,7 @@ title: Running Vikunja in a subdirectory
|
||||
slug: running-vikunja-in-a-subdirectory
|
||||
description: >-
|
||||
Learn how to run Vikunja in a subdirectory by building the frontend and
|
||||
configuring the API. Follow step-by-step instructions for custom setups and
|
||||
reverse proxy adjustments.
|
||||
configuring the API. Step-by-step guide for custom installations.
|
||||
---
|
||||
|
||||
Running Vikunja in a subdirectory is not supported out of the box.
|
||||
|
@ -2,9 +2,8 @@
|
||||
title: Using Typesense for enhanced search capabilities
|
||||
slug: typesense
|
||||
description: >-
|
||||
Learn how to set up and use Typesense with Vikunja for enhanced fulltext
|
||||
search functionality. Discover the benefits and installation process for
|
||||
improved task management and search results.
|
||||
Learn how to set up and use Typesense with Vikunja for improved fulltext
|
||||
search. Enhance your search experience with fast, fuzzy matching capabilities.
|
||||
---
|
||||
|
||||
Vikunja supports using [Typesense](https://typesense.org/) for a better search experience.
|
||||
|
@ -2,9 +2,8 @@
|
||||
title: UTF-8 Settings
|
||||
slug: utf-8-settings
|
||||
description: >-
|
||||
Learn how to ensure UTF-8 character support in Vikunja, including steps to
|
||||
convert MySQL databases. Improve your installation's compatibility with
|
||||
non-Latin characters and emojis.
|
||||
Learn how to ensure Vikunja supports non-Latin characters and emojis.
|
||||
Step-by-step guide for MySQL database conversion to UTF-8 encoding.
|
||||
---
|
||||
|
||||
Vikunja itself is always fully capable of handling utf-8 characters.
|
||||
|
@ -2,9 +2,9 @@
|
||||
title: Vikunja Versions
|
||||
slug: versions
|
||||
description: >-
|
||||
Learn about Vikunja API release types: stable with fixed versions and unstable
|
||||
with frequent updates. Discover how to switch between versions and understand
|
||||
the differences in builds and features.
|
||||
Learn about Vikunja API's stable and unstable release versions, their
|
||||
differences, and how to switch between them. Discover upgrade processes and
|
||||
best practices.
|
||||
---
|
||||
|
||||
Vikunja api is available in two different release flavors.
|
||||
|
@ -2,9 +2,8 @@
|
||||
title: API Documentation
|
||||
slug: api-documentation
|
||||
description: >-
|
||||
Discover Vikunja's API documentation, including autogenerated Swagger docs and
|
||||
OpenAPI specs. Access public instance or self-hosted API endpoints for
|
||||
seamless integration.
|
||||
Explore Vikunja's API documentation, including autogenerated Swagger docs and
|
||||
OpenAPI specifications. Access public instance or self-hosted API endpoints.
|
||||
---
|
||||
|
||||
You can find the api docs under `http://vikunja.tld/api/v1/docs` of your instance.<br />
|
||||
|
@ -2,9 +2,9 @@
|
||||
title: CalDAV
|
||||
slug: caldav
|
||||
description: >-
|
||||
Learn about Vikunja's CalDAV integration for task management. Discover
|
||||
supported features, compatible clients, and implementation details. Early
|
||||
alpha stage with known limitations.
|
||||
Explore Vikunja's CalDAV integration for task management. Learn about
|
||||
supported properties, URLs, and client compatibility. Early alpha stage with
|
||||
known limitations.
|
||||
---
|
||||
|
||||
> **Warning:** The CalDAV integration is in an early alpha stage and has bugs.
|
||||
|
@ -2,9 +2,8 @@
|
||||
title: Command line interface
|
||||
slug: cli
|
||||
description: >-
|
||||
Explore Vikunja's CLI interface for task management. Learn commands for
|
||||
database migrations, user management, indexing, and more. Enhance your
|
||||
productivity with Vikunja's powerful command-line tools.
|
||||
Learn how to use Vikunja's CLI interface for task management. Explore commands
|
||||
for user administration, database migration, indexing, and more.
|
||||
---
|
||||
|
||||
You can interact with Vikunja using its `cli` interface.
|
||||
|
@ -2,9 +2,8 @@
|
||||
title: Errors
|
||||
slug: errors
|
||||
description: >-
|
||||
Comprehensive guide to Vikunja error codes. Learn about HTTP status codes and
|
||||
descriptions for user, project, task, team, and other API-related errors in
|
||||
this detailed reference.
|
||||
Comprehensive guide to Vikunja error codes. Explore HTTP status codes and
|
||||
descriptions for user, project, task, team, and other system-related errors.
|
||||
---
|
||||
|
||||
This document describes the different errors Vikunja can return.
|
||||
|
@ -2,9 +2,8 @@
|
||||
title: Filter Syntax
|
||||
slug: filters
|
||||
description: >-
|
||||
Learn how to filter tasks via the Vikunja API using SQL-like query syntax.
|
||||
Discover available fields, operators, and examples to efficiently manage your
|
||||
tasks and projects.
|
||||
Learn how to filter tasks via API in Vikunja using SQL-like syntax. Discover
|
||||
available fields, operators, and examples for effective task management.
|
||||
---
|
||||
|
||||
To filter tasks via the api, you can use a query syntax similar to SQL.
|
||||
|
@ -3,8 +3,7 @@ title: Using Vikunja with n8n
|
||||
slug: n8n
|
||||
description: >-
|
||||
Learn how to integrate Vikunja with n8n using community nodes. Step-by-step
|
||||
guide for installation, authentication, and setting up API tokens for seamless
|
||||
automation workflows.
|
||||
guide for installation and authentication to automate tasks with Vikunja API.
|
||||
---
|
||||
|
||||
Vikunja maintains a [community node](https://github.com/go-vikunja/n8n-vikunja-nodes) for [n8n](https://n8n.io),
|
||||
|
@ -3,8 +3,8 @@ title: Available task relation kinds
|
||||
slug: task-relation-kinds
|
||||
description: >-
|
||||
Explore task relationship codes in project management. Learn about subtasks,
|
||||
parent tasks, blocking, and more. Understand how different tasks connect and
|
||||
interact in your projects.
|
||||
parent tasks, blocking, precedence, and more to improve your workflow
|
||||
organization.
|
||||
---
|
||||
|
||||
| Code | Description | Opposite of |
|
||||
|
@ -2,9 +2,9 @@
|
||||
title: Project rights for teams and users
|
||||
slug: rights
|
||||
description: >-
|
||||
Learn about project sharing rights and team admin roles. Understand how to
|
||||
control access levels, from read-only to full admin, and manage team
|
||||
permissions effectively.
|
||||
Learn about project sharing rights, including read-only, read-write, and admin
|
||||
access levels. Discover team admin roles and permissions for managing shared
|
||||
projects.
|
||||
---
|
||||
|
||||
Whenever you share a project with a user or team, you can specify a `rights` parameter.
|
||||
|
@ -2,9 +2,9 @@
|
||||
title: Webhooks
|
||||
slug: webhooks
|
||||
description: >-
|
||||
Learn how to create and manage webhooks in Vikunja. Explore available events,
|
||||
payload structure, and security considerations for integrating Vikunja with
|
||||
other services.
|
||||
Learn how to create and manage webhooks in Vikunja, including available
|
||||
events, payload structure, and security considerations for safe
|
||||
implementation.
|
||||
---
|
||||
|
||||
Starting with version 0.22.0, Vikunja allows you to define webhooks to notify other services of events happening within Vikunja.
|
||||
|
@ -1,6 +1,7 @@
|
||||
---
|
||||
title: "Imprint"
|
||||