From 59b131a263cd83718a882a62aa73e0fb8561394b Mon Sep 17 00:00:00 2001 From: devskillz47 Date: Tue, 26 Nov 2024 15:55:06 +0200 Subject: [PATCH 1/2] Issue#2693: Fix incorrect links Signed-off-by: devskillz47 --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 368abd697f..df9d40d217 100644 --- a/README.md +++ b/README.md @@ -154,7 +154,7 @@ docker exec -it fa7e3b4cec86 sh ## Building From Source -> :warning: Local builds are not supported and purely at your own risk. For contributing to Tremor please checkout our [Development Quick Start Guide](https://tremor.rs/docs/0.12/development/quick-start) +> :warning: Local builds are not supported and purely at your own risk. For contributing to Tremor please checkout our [Development Quick Start Guide](https://www.tremor.rs/community/development/quick-start) If you are not comfortable with managing library packages on your system or don't have experience with, please use the Docker image provided above. @@ -173,16 +173,16 @@ RUSTCFLAGS="-C cpu-target=native" cargo +nightly build --features neon --all ## Configuration -Tremor is configured using `.troy` files written in our own [Troy](https://tremor.rs/docs/0.12/language/troy/) language. +Tremor is configured using `.troy` files written in our own [Troy](https://www.tremor.rs/docs/0.12/language/) language. -Custom [Troy](https://tremor.rs/docs/0.12/language/troy/) modules can be loaded from any directory pointed to by the environment variable `TREMOR_PATH`. +Custom [Troy](https://www.tremor.rs/docs/0.12/language/) modules can be loaded from any directory pointed to by the environment variable `TREMOR_PATH`. Directory entries need to be separated by a colon `:`. ### Docker -For use in docker [Troy](https://tremor.rs/docs/0.12/language/troy/) files should be mounted to `/etc/tremor/config`. +For use in docker [Troy](https://www.tremor.rs/docs/0.12/language/) files should be mounted to `/etc/tremor/config`. -Custom [Troy](https://tremor.rs/docs/0.12/language/troy/) modules and libraries should be mounted to `/usr/local/share/tremor`. +Custom [Troy](https://www.tremor.rs/docs/0.12/language/) modules and libraries should be mounted to `/usr/local/share/tremor`. ### Example This very simple example will consume lines from stdin and send them to stdout. From 9ecc020bc2be7338ab011267ef3ccfb2a715675d Mon Sep 17 00:00:00 2001 From: devskillz47 Date: Sat, 21 Dec 2024 14:26:49 +0200 Subject: [PATCH 2/2] Issue#2701: Fix "broken" links Signed-off-by: devskillz47 --- README.md | 4 ++-- demo/README.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index df9d40d217..9aa2d6b6e8 100644 --- a/README.md +++ b/README.md @@ -70,8 +70,8 @@ We currently do not recommend tremor where: - Your event structure is not mappable to a JSON-like data structure. - If in doubt, please reach out and create a ticket so we can assist and advice - - In many cases ( textual formats ) a [preprocessor](https://www.tremor.rs/docs/artefacts/preprocessors/), [postprocessor](https://www.tremor.rs/docs/artefacts/postprocessors/) or [codec](https://www.tremor.rs/docs/artefacts/codecs/) is sufficient and these are relatively easy to contribute. -- You need connectivity to a system, protocol or technology that is not currently supported directly or indirectly by the existing set of [connectors](https://www.tremor.rs/docs/artefacts/connectors). + - In many cases ( textual formats ) a [preprocessor](https://www.tremor.rs/docs/0.12/reference/preprocessors/), [postprocessor](https://www.tremor.rs/docs/0.12/reference/postprocessors/) +- You need connectivity to a system, protocol or technology that is not currently supported directly or indirectly by the existing set of [connectors](https://www.tremor.rs/docs/0.12/reference/connectors/). - If in doubt, please reach out and create a ticket so we can assist and advise. - You require complex and expensive operations on your event streams like joins of huge streams. Tremor is not built for huge analytical datasets, rather for tapping into infinite datastreams at their source (e.g. k8s events, syslog, kafka). diff --git a/demo/README.md b/demo/README.md index 8601f2f06d..9545ae4e1a 100644 --- a/demo/README.md +++ b/demo/README.md @@ -2,7 +2,7 @@ This is a docker-compose based demonstration of some of the capabilities of Tremor. -It starts a kafka node, elasticsearch single-node cluster, kibana and influxdb and, last but not least, one Tremor instance. +It starts a kafka node, elasticsearch single-node cluster, kibana and influxdb and last, but not least, one Tremor instance. The two main files to check out are the `demo.yaml` compose file and the `configs/tremor/config/main.troy` file, containing the plumbing necessary for event routing and the core application logic.