search

go-vikunja / vikunja

Mirror of vikunja from https://code.vikunja.io/api
GNU Affero General Public License v3.0
758 stars 55 forks source link

patch to fix typos #263

Closed RayBB closed 1 month ago

RayBB commented 2 months ago

Description

Here is a patch to fix a bunch of typos on your website.

I don't want to create an account on your gitea instance right now to submit this patch so here it is as a file.

mypatch.patch

diff --git a/docs/content/doc/development/database.md b/docs/content/doc/development/database.md
index 780a5eb8b..4cb17e4f8 100644
--- a/docs/content/doc/development/database.md
+++ b/docs/content/doc/development/database.md
@@ -24,7 +24,7 @@ In other packages, use the `db.NewSession()` method to get a new database sessio

 To add a new table to the database, create the struct and [add a migration for it]({{< ref "db-migrations.md" >}}).

-To learn more about how to configure your struct to create "good" tables, refer to [the xorm documentaion](https://xorm.io/docs/).
+To learn more about how to configure your struct to create "good" tables, refer to [the xorm documentation](https://xorm.io/docs/).

 In most cases you will also need to implement the `TableName() string` method on the new struct to make sure the table name matches the rest of the tables - plural.

diff --git a/docs/content/doc/development/migration.md b/docs/content/doc/development/migration.md
index 4da0412b0..41339b28e 100644
--- a/docs/content/doc/development/migration.md
+++ b/docs/content/doc/development/migration.md
@@ -101,7 +101,7 @@ You should also document the routes with [swagger annotations]({{< ref "swagger-

 There is a method available in the `migration` package which takes a fully nested Vikunja structure and creates it with all relations.
 This means you start by adding a project, then add projects inside that project, then tasks in the lists and so on.
-In general, it is reccommended to have one root project with all projects of the other service as child projects.
+In general, it is recommended to have one root project with all projects of the other service as child projects.

 The root structure must be present as `[]*models.ProjectWithTasksAndBuckets`. It allows to represent all of Vikunja's hierarchy as a single data structure.

diff --git a/docs/content/doc/development/test.md b/docs/content/doc/development/test.md
index 0851e9fae..58bc11dfe 100644
--- a/docs/content/doc/development/test.md
+++ b/docs/content/doc/development/test.md
@@ -16,7 +16,7 @@ menu:

 The following parts are about the kinds of tests in the API package and how to run them.

-### Prerequesites
+### Prerequisites

 To run any kind of test, you need to specify Vikunja's [root path](https://vikunja.io/docs/config-options/#rootpath).
 This is required to make sure all test fixtures are correctly loaded.
@@ -39,7 +39,7 @@ This definition is a bit blurry, but we haven't found a better one yet.
 All integration tests live in `pkg/integrations`.
 You can run them by executing `mage test:integration`.

-The integration tests use the same config and fixtures as the unit tests and therefor have the same options available,
+The integration tests use the same config and fixtures as the unit tests and therefore have the same options available,
 see at the beginning of this document.

 To run integration tests, use `mage test:integration`.
diff --git a/docs/content/doc/setup/config.md b/docs/content/doc/setup/config.md
index c5210edec..9a92a88df 100644
--- a/docs/content/doc/setup/config.md
+++ b/docs/content/doc/setup/config.md
@@ -779,7 +779,7 @@ Environment path: `VIKUNJA_MAILER_PASSWORD`

 ### skiptlsverify

-Wether to skip verification of the tls certificate on the server
+Whether to skip verification of the tls certificate on the server

 Default: `false`

@@ -1222,7 +1222,7 @@ OpenID configuration will allow users to authenticate through a third-party Open
 The provider needs to support the `openid`, `profile` and `email` scopes.<br/>
 **Note:** Some openid providers (like Gitlab) only make the email of the user available through OpenID if they have set it to be publicly visible.
 If the email is not public in those cases, authenticating will fail.
-**Note 2:** The frontend expects the third party to rediect the user <frontend-url>/auth/openid/<auth key> after authentication. Please make sure to configure the redirect url in your third party auth service accordingly if you're using the default vikunja frontend.
+**Note 2:** The frontend expects the third party to redirect the user <frontend-url>/auth/openid/<auth key> after authentication. Please make sure to configure the redirect url in your third party auth service accordingly if you're using the default vikunja frontend.
 The frontend will automatically provide the API with the redirect url, composed from the current url where it's hosted.
 If you want to use the desktop client with OpenID, make sure to allow redirects to `127.0.0.1`.
 Take a look at the [default config file](https://kolaente.dev/vikunja/vikunja/src/branch/main/config.yml.sample) for more information about how to configure openid authentication.
@@ -1423,7 +1423,7 @@ Environment path: `VIKUNJA_WEBHOOKS_ENABLED`

 ### timoutseconds

-The timout in seconds until a webhook request fails when no response has been received.
+The timeout in seconds until a webhook request fails when no response has been received.

 Default: `30`

diff --git a/docs/content/doc/setup/full-docker-example.md b/docs/content/doc/setup/full-docker-example.md
index e7ecb037d..76103019d 100644
--- a/docs/content/doc/setup/full-docker-example.md
+++ b/docs/content/doc/setup/full-docker-example.md
@@ -40,7 +40,7 @@ chown 1000 $PWD/files

 You'll need to do this before running any of the examples on this page.

-Vikunja will not try to aquire ownership of the files folder, as that would mean it had to run as root.
+Vikunja will not try to acquire ownership of the files folder, as that would mean it had to run as root.

 ## PostgreSQL

@@ -312,7 +312,7 @@ To do that, you can

 * Either activate SSH and paste the adapted compose file in a terminal (using Putty or similar)
 * Without activating SSH as a "custom script" (go to Control Panel / Task Scheduler / Create / Scheduled Task / User-defined script)
-* Without activating SSH, by using Portainer (you have to install first, check out [this tutorial](https://www.portainer.io/blog/how-to-install-portainer-on-a-synology-nas) for exmple):
+* Without activating SSH, by using Portainer (you have to install first, check out [this tutorial](https://www.portainer.io/blog/how-to-install-portainer-on-a-synology-nas) for example):
   1. Go to **Dashboard / Stacks** click the button **"Add Stack"**
   2. Give it the name Vikunja and paste the adapted docker compose file
   3. Deploy the Stack with the "Deploy Stack" button:
diff --git a/docs/content/doc/setup/install.md b/docs/content/doc/setup/install.md
index bd5c4a624..69665286c 100644
--- a/docs/content/doc/setup/install.md
+++ b/docs/content/doc/setup/install.md
@@ -37,7 +37,7 @@ This document provides an overview and instructions for the different methods:
 * [FreeBSD](#freebsd--freenas)
 * [Kubernetes]({{< ref "k8s.md" >}})

-And after you installed Vikunja, you may want to check out these other ressources:
+And after you installed Vikunja, you may want to check out these other resources:

 * [Configuration]({{< ref "config.md">}})
 * [UTF-8 Settings]({{< ref "utf-8.md">}})
@@ -229,7 +229,7 @@ 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.
+**Note:** 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.

 ### Compile binaries
diff --git a/docs/content/doc/setup/openid.md b/docs/content/doc/setup/openid.md
index f639dacc0..081ab0579 100644
--- a/docs/content/doc/setup/openid.md
+++ b/docs/content/doc/setup/openid.md
@@ -17,7 +17,7 @@ Vikunja allows for authentication with an external identity source such as Authe

 ## OpenID Connect Overview

-OpenID Connect is a standardized identity layer built on top of the more generic OAuth 2.0 specification, simplying interaction between the involved parties significantly.
+OpenID Connect is a standardized identity layer built on top of the more generic OAuth 2.0 specification, simplifying interaction between the involved parties significantly.
 While the [OpenID specification](https://openid.net/specs/openid-connect-core-1_0.html#Overview) is worth a read, we summarize the most important basics here.

 The involved parties are:
diff --git a/docs/content/doc/setup/subdirectory.md b/docs/content/doc/setup/subdirectory.md
index d4324f533..02fc26c0c 100644
--- a/docs/content/doc/setup/subdirectory.md
+++ b/docs/content/doc/setup/subdirectory.md
@@ -17,7 +17,7 @@ However, you can still run it in a subdirectory but need to build the frontend y
 First, make sure you're able to build the frontend from source.
 Check [the guide about building from source]({{< ref "build-from-source.md">}}#frontend) about that.

-### Dynamicly set with build command
+### Dynamically set with build command

 Run the build with the `VIKUNJA_FRONTEND_BASE` variable specified.

diff --git a/docs/content/doc/usage/cli.md b/docs/content/doc/usage/cli.md
index 9e1035f87..c0dd2abbb 100644
--- a/docs/content/doc/usage/cli.md
+++ b/docs/content/doc/usage/cli.md
@@ -147,7 +147,7 @@ Flags:
 #### `user delete`

 Start the user deletion process.
-If called without the `--now` flag, this command will only trigger an email to the user in order for them to confirm and start the deletion process (this is the same behavoir as if the user requested their deletion via the web interface).
+If called without the `--now` flag, this command will only trigger an email to the user in order for them to confirm and start the deletion process (this is the same behavior as if the user requested their deletion via the web interface).
 With the flag the user is deleted **immediately**.

 **USE WITH CAUTION.**
diff --git a/docs/content/doc/usage/errors.md b/docs/content/doc/usage/errors.md
index 8183f44c3..a02620a08 100644
--- a/docs/content/doc/usage/errors.md
+++ b/docs/content/doc/usage/errors.md
@@ -51,7 +51,7 @@ This document describes the different errors Vikunja can return.
 | ErrorCode | HTTP Status Code | Description |
 |-----------|------------------|-------------|
 | 2001 | 400 | ID cannot be empty or 0. |
-| 2002 | 400 | Some of the request data was invalid. The response contains an aditional array with all invalid fields. |
+| 2002 | 400 | Some of the request data was invalid. The response contains an additional array with all invalid fields. |

 ## Project

diff --git a/docs/content/doc/usage/webhooks.md b/docs/content/doc/usage/webhooks.md
index ea9bc2b43..918121b58 100644
--- a/docs/content/doc/usage/webhooks.md
+++ b/docs/content/doc/usage/webhooks.md
@@ -18,7 +18,7 @@ Starting with version 0.22.0, Vikunja allows you to define webhooks to notify ot

 To create a webhook, in the project options select "Webhooks". The form will allow you to create and modify webhooks.

-Check out [the api docs](https://try.vikunja.io/api/v1/docs#tag/webhooks) for information about how to create webhooks programatically.
+Check out [the api docs](https://try.vikunja.io/api/v1/docs#tag/webhooks) for information about how to create webhooks programmatically.

 ## Available events and their payload

Vikunja Version

latest

Browser and version

No response

Can you reproduce the bug on the Vikunja demo site?

Yes

Screenshots

No response

kolaente commented 1 month ago

Thanks! I've applied your changes in https://github.com/go-vikunja/vikunja/commit/eee7b060b65fb9b35c0bca0e4f69b66b56a8fe0f.

What prevents you from opening an account on the Gitea instance?

RayBB commented 1 month ago

Busy with my thesis (which is part of why I setup Vikunja locally) and didn't wanna bother with the steps in git to add the remote repo and figure out those bits. But I love the project so far so wanted to do the minimum I could to contribute :)