Skip to content

Commit

Permalink
Merge pull request #105 from openkfw/next
Browse files Browse the repository at this point in the history
Bump Doc 648f2bb
  • Loading branch information
MartinJurcoGlina authored Sep 23, 2024
2 parents d1449a4 + f926489 commit 9fde110
Show file tree
Hide file tree
Showing 637 changed files with 2,343 additions and 1,847 deletions.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Installation - How to install TruBudget
- [Deploying using Docker](./operation-administration/installation/create-a-new-network/docker.md)
- [Environment Variables](./operation-administration/introduction.md#environment-variables)
- [Organizations and Nodes](./operation-administration/introduction.md#organizations-and-nodes-in-trubudget)
- [Node connection process](./operation-administration/installation/create-a-new-network/connection-process.md)
- [Node connection process](./operation-administration/installation/create-a-new-network/docker.md)
- [Connect to an existing network](./operation-administration/installation/connect-to-an-existing-network/docker.md)
- [Update TruBudget](./operation-administration/update-trubudget.md)
- [Logging](./operation-administration/logging-monitoring.md) - Information on the API log and how to handle it
Expand Down
4 changes: 2 additions & 2 deletions docs/developer/api-docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ Check out our [ADRs](../doc/adr/) to learn about our current way of doing things

#### Get started

Before starting the API, environment variables have to be set under `.env` file. The `.env_example` file provides the default/example values for the environment variables. Just make a copy of example file via:
Before starting the API, environment variables have to be set under `.env` file. The `.env.example` file provides the default/example values for the environment variables. Just make a copy of example file via:

```bash
cp .env_example .env
cp .env.example .env
```

Default values are usually enough to setup a working local Trubudget instance. However you are free to change the variable values under .env file.
Expand Down
24 changes: 12 additions & 12 deletions docs/developer/api-docs/classes/error.TruBudgetError.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Error.constructor

#### Defined in

[src/error.ts:135](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/error.ts#L135)
[src/error.ts:135](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/error.ts#L135)

## Properties

Expand All @@ -69,7 +69,7 @@ Error.constructor

#### Defined in

[src/error.ts:121](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/error.ts#L121)
[src/error.ts:121](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/error.ts#L121)

___

Expand All @@ -79,7 +79,7 @@ ___

#### Defined in

[src/error.ts:113](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/error.ts#L113)
[src/error.ts:113](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/error.ts#L113)

___

Expand All @@ -89,7 +89,7 @@ ___

#### Defined in

[src/error.ts:131](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/error.ts#L131)
[src/error.ts:131](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/error.ts#L131)

___

Expand All @@ -99,7 +99,7 @@ ___

#### Defined in

[src/error.ts:129](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/error.ts#L129)
[src/error.ts:129](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/error.ts#L129)

___

Expand All @@ -109,7 +109,7 @@ ___

#### Defined in

[src/error.ts:117](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/error.ts#L117)
[src/error.ts:117](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/error.ts#L117)

___

Expand All @@ -119,7 +119,7 @@ ___

#### Defined in

[src/error.ts:133](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/error.ts#L133)
[src/error.ts:133](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/error.ts#L133)

___

Expand Down Expand Up @@ -157,7 +157,7 @@ ___

#### Defined in

[src/error.ts:127](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/error.ts#L127)
[src/error.ts:127](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/error.ts#L127)

___

Expand All @@ -181,7 +181,7 @@ ___

#### Defined in

[src/error.ts:125](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/error.ts#L125)
[src/error.ts:125](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/error.ts#L125)

___

Expand All @@ -191,7 +191,7 @@ ___

#### Defined in

[src/error.ts:123](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/error.ts#L123)
[src/error.ts:123](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/error.ts#L123)

___

Expand All @@ -201,7 +201,7 @@ ___

#### Defined in

[src/error.ts:119](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/error.ts#L119)
[src/error.ts:119](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/error.ts#L119)

___

Expand All @@ -211,7 +211,7 @@ ___

#### Defined in

[src/error.ts:115](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/error.ts#L115)
[src/error.ts:115](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/error.ts#L115)

___

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ VError.constructor

#### Defined in

[src/http_errors/bad_request.ts:13](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/http_errors/bad_request.ts#L13)
[src/http_errors/bad_request.ts:13](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/http_errors/bad_request.ts#L13)

## Properties

Expand Down
28 changes: 14 additions & 14 deletions docs/developer/api-docs/classes/lib_db.default.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@

#### Defined in

[src/lib/db.ts:12](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/lib/db.ts#L12)
[src/lib/db.ts:12](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/lib/db.ts#L12)

___

Expand All @@ -54,7 +54,7 @@ ___

#### Defined in

[src/lib/db.ts:15](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/lib/db.ts#L15)
[src/lib/db.ts:15](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/lib/db.ts#L15)

___

Expand All @@ -64,7 +64,7 @@ ___

#### Defined in

[src/lib/db.ts:14](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/lib/db.ts#L14)
[src/lib/db.ts:14](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/lib/db.ts#L14)

___

Expand All @@ -74,7 +74,7 @@ ___

#### Defined in

[src/lib/db.ts:16](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/lib/db.ts#L16)
[src/lib/db.ts:16](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/lib/db.ts#L16)

## Methods

Expand All @@ -88,7 +88,7 @@ ___

#### Defined in

[src/lib/db.ts:149](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/lib/db.ts#L149)
[src/lib/db.ts:149](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/lib/db.ts#L149)

___

Expand All @@ -108,7 +108,7 @@ ___

#### Defined in

[src/lib/db.ts:98](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/lib/db.ts#L98)
[src/lib/db.ts:98](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/lib/db.ts#L98)

___

Expand All @@ -122,7 +122,7 @@ ___

#### Defined in

[src/lib/db.ts:44](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/lib/db.ts#L44)
[src/lib/db.ts:44](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/lib/db.ts#L44)

___

Expand All @@ -143,7 +143,7 @@ ___

#### Defined in

[src/lib/db.ts:18](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/lib/db.ts#L18)
[src/lib/db.ts:18](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/lib/db.ts#L18)

___

Expand All @@ -157,7 +157,7 @@ ___

#### Defined in

[src/lib/db.ts:29](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/lib/db.ts#L29)
[src/lib/db.ts:29](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/lib/db.ts#L29)

___

Expand All @@ -177,7 +177,7 @@ ___

#### Defined in

[src/lib/db.ts:113](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/lib/db.ts#L113)
[src/lib/db.ts:113](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/lib/db.ts#L113)

___

Expand All @@ -191,7 +191,7 @@ ___

#### Defined in

[src/lib/db.ts:51](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/lib/db.ts#L51)
[src/lib/db.ts:51](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/lib/db.ts#L51)

___

Expand All @@ -205,7 +205,7 @@ ___

#### Defined in

[src/lib/db.ts:135](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/lib/db.ts#L135)
[src/lib/db.ts:135](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/lib/db.ts#L135)

___

Expand All @@ -227,7 +227,7 @@ ___

#### Defined in

[src/lib/db.ts:79](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/lib/db.ts#L79)
[src/lib/db.ts:79](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/lib/db.ts#L79)

___

Expand All @@ -241,4 +241,4 @@ ___

#### Defined in

[src/lib/db.ts:68](https://github.com/openkfw/TruBudget/blob/1602d8b/api/src/lib/db.ts#L68)
[src/lib/db.ts:68](https://github.com/openkfw/TruBudget/blob/2e83742/api/src/lib/db.ts#L68)
Loading

0 comments on commit 9fde110

Please sign in to comment.