docs: improve eventstore docs (#3905)

* docs: improve eventstore docs

* docs: fix broken link

* docs(installation): fix broken link
This commit is contained in:
Elio Bischof 2022-07-07 09:20:51 +02:00 committed by GitHub
parent 3267daedda
commit f4ae4523fa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 6 additions and 5 deletions

View File

@ -22,8 +22,9 @@ The data is stored as events in an append-only log.
## Benefits ## Benefits
Audit: You have a built-in audit trail that tracks all changes over an unlimited period of time. - Audit: You have a built-in audit trail that tracks all changes over an unlimited period of time.
Travel back in time: With our way of storing data we can show you all of your resources at a given point in time. - Travel back in time: With our way of storing data we can show you all of your resources at a given point in time.
- Future Projections: It is easy to compute projections with new business logic by replaying all events since installation.
## Definitions ## Definitions
@ -43,7 +44,7 @@ Possible Events:
### Aggregate ### Aggregate
An aggregate consist of multiple events. All events together in will lead to the current state of the aggregate. An aggregate consist of multiple events. All events together in will lead to the current state of the aggregate.
The aggregate can be compared with an object or a resources. The aggregate can be compared with an object or a resources. Aggregates define transaction boundaries.
### Projections ### Projections

View File

@ -68,7 +68,7 @@ This is the IAM admin users login according to your configuration in the [exampl
- Read more about [the login process](../../manuals/user-login). - Read more about [the login process](../../manuals/user-login).
- If you want to run ZITADEL in production, you most certainly need to [customize your own domain](./custom-domain). - If you want to run ZITADEL in production, you most certainly need to [customize your own domain](./custom-domain).
- Check out all possible [runtime configuration properties and their defaults in the source code](https://github.com/zitadel/zitadel/blob/v2-alpha/cmd/defaults.yaml) - Check out all possible [runtime configuration properties and their defaults in the source code](https://github.com/zitadel/zitadel/blob/v2-alpha/cmd/defaults.yaml)
- Check out all possible [setup step configuration properties and their defaults in the source code](https://github.com/zitadel/zitadel/blob/v2-alpha/cmd/adminn/setup/steps.yaml) - Check out all possible [setup step configuration properties and their defaults in the source code](https://github.com/zitadel/zitadel/blob/v2-alpha/cmd/setup/steps.yaml)
:::caution :::caution

View File

@ -4,7 +4,7 @@ By executing the commands below, you will download the file [docker-compose.yaml
```bash ```bash
# Download the docker compose example configuration. For example: # Download the docker compose example configuration. For example:
wget https://raw.githubusercontent.com/zitadel/zitadel/v2-alpha/docs/docs/guides/installation/get-started/docker-compose.yaml wget https://raw.githubusercontent.com/zitadel/zitadel/v2-alpha/docs/docs/guides/installation/run/docker-compose.yaml
# Run the database and application containers # Run the database and application containers
docker compose up --detach docker compose up --detach