vikunja/website
2
0
Fork 3
Code Issues 1 Pull Requests 2 Actions Packages Projects Releases Wiki Activity

fix: update generation docs

Browse Source
This commit is contained in:
kolaente 2024-09-22 14:41:02 +02:00
parent f2f7d9e747
commit ce7aef0316
Signed by: konrad
GPG Key ID: F40E70337AB24C9B
3 changed files with 20 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/content/docs/development/config.mdoc
View File

@ -16,7 +16,7 @@ To add a new config option, you should add a new key const to `pkg/config/config
Default values should always enable the feature to work or turn it off completely if it always needs
additional configuration.
Make sure to also add the new config option to the default config file (`config.yml.sample` at the root of the repository)
Make sure to also add the new config option to the `config-raw.json` file at the root of the repository
with an explanatory comment to make sure it is well documented.
Then run `mage generate-docs` to generate the configuration docs from the sample file.

26
src/content/docs/development/mage.mdoc
View File

@ -146,6 +146,24 @@ Will ask for the name of the struct you want to create a migration for.
See also [migration docs](/docs/magefile).
## Generate documentation
### Swagger docs
```sh
mage generate:swagger-docs
```
Generates swagger definitions from the comment annotations in the code.
### config.yml sample file
```sh
mage generate:config-yaml
```
This generates a `config.yml.sample` file from the content in `config-raw.json` file. This happens automatically when building packages and only really needs to happen at that time.
## Misc
### Format the code
@ -155,11 +173,3 @@ mage fmt
```
Formats all source code using `go fmt`.
### Generate swagger definitions from code comments
```sh
mage do-the-swag
```
Generates swagger definitions from the comment annotations in the code.

2
src/content/docs/setup/migration.mdoc
View File

@ -4,7 +4,7 @@ slug: migration-from-third-party-services
---
There are several importers available for third-party services like Trello, Microsoft To Do or Todoist.
All available migration options can be found [here](https://kolaente.dev/vikunja/vikunja/src/branch/main/config.yml.sample#L218).
All available migration options can be found [in the docs](/docs/config-options#migration).
You can develop migrations for more services, see the [documentation](/docs/migrations) for more info.