The tremor-www from tremor-rs

Update main page

Update main to ensure they're up to date

archive tremor-rs/tremor-www-msin
update content
disable tremor-rs/tremor-www-main
update cname for www.tremor.rs and tremor.rs
enable forwards/rewrites for docs.tremor.rs
enable forwards/rewrites for rfcs.tremor.rs

Update otel recipes to account for changes in otel-collector docker image

The recipe docker-compose files refer to otel-collector images via a latest tag. The config
has changed and the pprof and health_check extensions are no longer valid so the docker
compose configuration needs to change:

diff --git a/docs/recipes/40_otel_passthrough/etc/otel/collector-config.yaml b/docs/recipes/40_otel_passthrough/etc/otel/collector-config.yaml
index 4db0a956..33b1f83e 100644
--- a/docs/recipes/40_otel_passthrough/etc/otel/collector-config.yaml
+++ b/docs/recipes/40_otel_passthrough/etc/otel/collector-config.yaml
@@ -10,14 +10,11 @@ processors:
   batch:

 extensions:
-  health_check:
-  pprof:
-    endpoint: :1888
   zpages:
     endpoint: :55679

 service:
-  extensions: [pprof, zpages, health_check]
+  extensions: [zpages]
   pipelines:
     logs:
       receivers: [otlp]

Discovered by Endre and reported via tremor chat - the above workaround was a quick fix for Endre - but we should really pin the version and update the otel recipes accordingly!

Reorganize your documentation's information architecture

This is an extract from the Docs Assessment done by @celestehorgan

In addition to the suggestions above, I recommend an overall reorganization of the documentation, along the lines of:

Docs
- Overview (renamed from Architecture Overview)
- Using Tremor
  - subpages as described previously
- Artifacts
- Tremor Query
- Tremor Script
- Examples (renamed from Workshops)
- API Reference
- Glossary
- FAQ (moved from top level navigation)

The developper getting started guide is super hard to find

https://www.tremor.rs/community/development/quick-start is quite hard to find we should make it easier to discover

Turn the Community page into a subsection and house Governance and Development documentation under it

This is an extract from the Docs Assessment done by @celestehorgan

Specifically, move Development to /community/development
Move The entire governance section as well
Consider moving RFCs under community as well

Reorganize the top-level navigation of the site

This is an extract from the Docs Assessment done by @celestehorgan

once again, as mentioned previously:

Getting Started
Docs
- subsections as described above
Community
- RFCs
- Contributing (moved from Docs section)
- Governance (moved from Docs section)
Community Chat
Blog

Consolidate documentation into one repository, and document contributing guidelines for users

This is an extract from the Docs Assessment done by @celestehorgan

I recommend collapsing everything into https://github.com/tremor-rs/tremor-www-main, barring any technical difficulties doing so, and switching deploys over to Netlify to access Deploy previews and other useful features.

Reorganize [Overview](https://docs.tremor.rs/overview/) with user-centeredness in mind

This is an extrat from the Docs Assessment done by @celestehorgan

--

I suggest creating a new section with the following content:
- The information on The docs index as a page titled "Overview", with subpages:
- Architecture Overview (note: you could break out each of the "Model" sections into their own subpages)
- History, and I would consider titling this "Release log" or something similar
- Understanding Data

Add a recipe for connecting to Netlify log drains with tremor

Netlify supports configuring log drains with json payloads to distribute log events.

Adding a recipe on how to configure log drains and process the events with tremor would be a great contribution.

Document sundown policy

The sundown policy and the pragmatic policies around when to expect upgrades
and what the tremor team's priorities around support is needs to be documented
clearly to reflect current procedures and practice.

Category index pages

Those would be nice, will be available in October :)

so "extractors" in this would become a index itself instead of having extractors as a page and extractors as a category

for reference: facebook/docusaurus#2643 (comment)

Improve display of bench results

right now benchmark results are scaled in a very odd way, they're too high to be readable easily. Reworking this to make them look more readable and better looking would be very nice they can be found here: https://www.tremor.rs/benchmarks/

tremor-query is missing

Fix navigation and improve site maintainability by putting all your documentation in one repository

This is an extract from the Docs Assessment done by @celestehorgan

Syntax diagrams do not work on the dark theme

For the dark theme, syntax diagrams are not readable as the arrows blend into the background color.

Document all the available pre- and postprocessors and list them sorted alphabetically

Currently we only list those preprocessors:

But we support this whole list:

Missing preprocessors:

gelf-chunking-tcp
zstd
ingest-ns

Incorrectly listed preprocessors:

xz -> xz2

Same is true for postprocessors:

Missing postprocessors:

zstd
ingest-ns

Incorrectly listed:

xz -> xz2

Also they should be listed alphabetically.

Pull meeting and contact information out of contributing and onto the community page

This is an extract from the Docs Assessment done by @celestehorgan

people cannot join a meeting or chat that they can't find a link to.

use cached tremor binary for stdlib generation

We should not re-compile tremor every time we generate the stdlib, the build process would be significantly faster if we were to use a pre-build tremor and just checkout the stdlib itself

update callouts to docusaurus

Callouts in mkdocs were done with:

!!! note (or other type)
    here goes the note text

now they're done with:

:::note (or other type) This is the note title

here goes the note text

:::

events link leads to a dead end

The events and media page in the community menu leads to a dead end: https://www.tremor.rs/community/EventsAndMedia.md

extend alex to all markdown files

Currently alex only reads the toplevel files

Rename Workshops section to "Recipes" or "Examples"

This is an extract from the Docs Assessment done by @celestehorgan

Broken Links

Due to the redesign/migration, there are a lot of broken internal links that need to be fixed.

Frequent broken links are linking to:

/faqs/
/docs/
/docs/course/#/2

This is the exhaustive list of all broken links found:

On source page path = /404.html:

-> linking to /faqs/
On source page path = /:
-> linking to /faqs/
On source page path = /api/0:
-> linking to /faqs/
On source page path = /blog:
-> linking to /docs/
-> linking to /docs/course/#/2 (resolved as: /docs/course/)
-> linking to /faqs/
On source page path = /blog/2020/02/22/welcome:
-> linking to /faqs/
On source page path = /blog/2020/03/06/influx-perf:
-> linking to /faqs/
On source page path = /blog/2020/03/31/rust-and-tell:
-> linking to /faqs/
On source page path = /blog/2020/08/06/to-async-or-not-to-async:
-> linking to /faqs/
On source page path = /blog/2020/10/16/v09-release:
-> linking to /faqs/
On source page path = /blog/2021/06/29/T17-LFX-Blog-Jigyasa-gcloud:
-> linking to /docs/course/#/2 (resolved as: /docs/course/)
-> linking to /docs/workshop/examples/20_transient_gd/
-> linking to /docs/workshop/examples/21_persistent_gd/
-> linking to /faqs/
On source page path = /blog/2021/07/06/Blog-Rohit-Property-Based-Testing:
-> linking to /docs/tremor-script/#patch (resolved as: /docs/tremor-script/)
-> linking to /faqs/
On source page path = /blog/archive:
-> linking to /faqs/
On source page path = /blog/LFX-Blog-Nupur:
-> linking to /docs/
-> linking to /faqs/
On source page path = /blog/tags:
-> linking to /faqs/
On source page path = /blog/tags/announcement:
-> linking to /faqs/
On source page path = /blog/tags/cncf:
-> linking to /docs/
-> linking to /docs/course/#/2 (resolved as: /docs/course/)
-> linking to /faqs/
On source page path = /blog/tags/codecs:
-> linking to /docs/
-> linking to /faqs/
On source page path = /blog/tags/connectors:
-> linking to /docs/course/#/2 (resolved as: /docs/course/)
-> linking to /faqs/
On source page path = /blog/tags/dev:
-> linking to /faqs/
On source page path = /blog/tags/gpc:
-> linking to /docs/course/#/2 (resolved as: /docs/course/)
-> linking to /faqs/
On source page path = /blog/tags/hello:
-> linking to /faqs/
On source page path = /blog/tags/mentorship:
-> linking to /docs/
-> linking to /docs/course/#/2 (resolved as: /docs/course/)
-> linking to /faqs/
On source page path = /blog/tags/open-source:
-> linking to /faqs/
On source page path = /blog/tags/perf:
-> linking to /faqs/
On source page path = /blog/tags/releases:
-> linking to /faqs/
On source page path = /blog/tags/rust:
-> linking to /faqs/
On source page path = /blog/tags/talks:
-> linking to /faqs/
On source page path = /blog/tags/testing:
-> linking to /faqs/
On source page path = /blog/tags/tremorscript:
-> linking to /faqs/
On source page path = /blog/tags/welcome:
-> linking to /faqs/
On source page path = /community/tags:
-> linking to /faqs/
On source page path = /docs/next/tags:
-> linking to /faqs/
On source page path = /docs/tags:
-> linking to /faqs/
On source page path = /quick-start:
-> linking to /faqs/
On source page path = /rfc/tags:
-> linking to /faqs/
On source page path = /docs/next/artefacts/codecs:
-> linking to /faqs/
On source page path = /docs/next/artefacts/offramps:
-> linking to codecs.md#json (resolved as: /docs/next/artefacts/codecs.md)
-> linking to ./onramps.md#rest (resolved as: /docs/next/artefacts/onramps.md)
-> linking to ../operations/linked-transports.md (resolved as: /docs/next/operations/linked-transports.md)
-> linking to /faqs/
On source page path = /docs/next/artefacts/onramps:
-> linking to ../scripting/tremor-script/stdlib/tremor/origin.md (resolved as: /docs/next/scripting/tremor-script/stdlib/tremor/origin.md)
-> linking to /faqs/
On source page path = /docs/next/artefacts/postprocessors:
-> linking to /faqs/
On source page path = /docs/next/artefacts/preprocessors:
-> linking to /faqs/
On source page path = /docs/next/ConstraintsLimitations:
-> linking to /faqs/
On source page path = /docs/next/glossary:
-> linking to /faqs/
On source page path = /docs/next/history:
-> linking to scripting/tremor-script/stdlib/tremor/chash.md (resolved as: /docs/next/scripting/tremor-script/stdlib/tremor/chash.md)
-> linking to operations/cli.md (resolved as: /docs/next/operations/cli.md)
-> linking to /faqs/
On source page path = /docs/next/index:
-> linking to operations/cli.md (resolved as: /docs/next/operations/cli.md)
-> linking to /api
-> linking to /faqs/
On source page path = /docs/next/operations/configuration:
-> linking to /faqs/
On source page path = /docs/next/operations/configuration-walkthrough:
-> linking to /faqs/
On source page path = /docs/next/operations/gdcb:
-> linking to /faqs/
On source page path = /docs/next/operations/linked-transports:
-> linking to /faqs/
On source page path = /docs/next/operations/monitoring:
-> linking to /faqs/
On source page path = /docs/next/overview:
-> linking to /faqs/
On source page path = /docs/next/recipes/bridges_lt_http_ws/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/configurator/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/filter/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/grafana/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/influx/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/kafka_elastic_correlation/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/kafka_gd/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/logstash/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/otel_elastic_apm/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/otel_jaeger/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/otel_passthrough/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/otel_prometheus/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/otel_zipkin/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/passthrough/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/persistent_gd/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/polling_alerts/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/postgres_timescaledb/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/proxies_lt_http/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/proxies_lt_ws/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/quota_service/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/reverse_proxy_load_balancing/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/roundrobin/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/servers_lt_http/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/servers_lt_ws/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/syslog_udp_dns/README:
-> linking to ../14_syslog_udp/ (resolved as: /docs/next/recipes/14_syslog_udp/)
-> linking to /faqs/
On source page path = /docs/next/recipes/syslog_udp/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/transform/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/transient_gd/README:
-> linking to /faqs/
On source page path = /docs/next/recipes/validate/README:
-> linking to /faqs/
On source page path = /docs/next/scripting/ pp:
-> linking to /faqs/
On source page path = /docs/next/scripting/modules:
-> linking to /faqs/
On source page path = /docs/next/scripting/tremor-query/functions:
-> linking to /faqs/
On source page path = /docs/next/scripting/tremor-query/functions/stats:
-> linking to /faqs/
On source page path = /docs/next/scripting/tremor-query/functions/win:
-> linking to /faqs/
On source page path = /docs/next/scripting/tremor-query/index:
-> linking to ../tremor-script/stdlib/tremor/origin.md (resolved as: /docs/next/scripting/tremor-script/stdlib/tremor/origin.md)
-> linking to /faqs/
On source page path = /docs/next/scripting/tremor-query/operators:
-> linking to /faqs/
[ ]On source page path = /docs/next/scripting/tremor-query/recipes:
-> linking to /faqs/
On source page path = /docs/next/scripting/tremor-query/walkthrough:
-> linking to /faqs/
On source page path = /docs/next/scripting/tremor-script/extractors/base64:
-> linking to /faqs/
On source page path = /docs/next/scripting/tremor-script/extractors/cidr:
-> linking to /faqs/
On source page path = /docs/next/scripting/tremor-script/extractors/datetime:
-> linking to /faqs/
On source page path = /docs/next/scripting/tremor-script/extractors/dissect:
-> linking to /faqs/
On source page path = /docs/next/scripting/tremor-script/extractors/glob:
-> linking to /faqs/
On source page path = /docs/next/scripting/tremor-script/extractors/grok:
-> linking to /faqs/
On source page path = /docs/next/scripting/tremor-script/extractors/index:
-> linking to /faqs/
On source page path = /docs/next/scripting/tremor-script/extractors/influx:
-> linking to /faqs/
On source page path = /docs/next/scripting/tremor-script/extractors/json:
-> linking to /faqs/
On source page path = /docs/next/scripting/tremor-script/extractors/kv:
-> linking to /faqs/
On source page path = /docs/next/scripting/tremor-script/extractors/regex:
-> linking to /faqs/
On source page path = /docs/next/scripting/tremor-script/functions:
-> linking to /faqs/
On source page path = /docs/next/scripting/tremor-script/index:
-> linking to stdlib/std/integer.md (resolved as: /docs/next/scripting/tremor-script/stdlib/std/integer.md)
-> linking to stdlib/std/float.md (resolved as: /docs/next/scripting/tremor-script/stdlib/std/float.md)
-> linking to stdlib/std/string.md (resolved as: /docs/next/scripting/tremor-script/stdlib/std/string.md)
-> linking to stdlib/std/array.md (resolved as: /docs/next/scripting/tremor-script/stdlib/std/array.md)
-> linking to stdlib/std/record.md (resolved as: /docs/next/scripting/tremor-script/stdlib/std/record.md)
-> linking to stdlib/std/binary.md (resolved as: /docs/next/scripting/tremor-script/stdlib/std/binary.md)
-> linking to stdlib/std/string.md#into_binarybytes (resolved as: /docs/next/scripting/tremor-script/stdlib/std/string.md)
-> linking to stdlib/std/string.md#from_utf8_lossybytes (resolved as: /docs/next/scripting/tremor-script/stdlib/std/string.md)
-> linking to stdlib/std/base64.md (resolved as: /docs/next/scripting/tremor-script/stdlib/std/base64.md)
-> linking to /docs/tremor-query/#select-queries (resolved as: /docs/tremor-query/)
-> linking to /faqs/
On source page path = /docs/next/scripting/tremor-script/recipes:
-> linking to stdlib/std/array.md#pusharray-element (resolved as: /docs/next/scripting/tremor-script/stdlib/std/array.md)
-> linking to stdlib/std/random.md (resolved as: /docs/next/scripting/tremor-script/stdlib/std/random.md)
-> linking to stdlib/std/type.md#is_nullvalue (resolved as: /docs/next/scripting/tremor-script/stdlib/std/type.md)
-> linking to /faqs/
On source page path = /community/community:
-> linking to /faqs/
On source page path = /community/development/benchmarking:
-> linking to /faqs/
On source page path = /community/development/benchmarks/LogstashBenchmark:
-> linking to /faqs/
On source page path = /community/development/debugging:
-> linking to /faqs/
On source page path = /community/development/internal/running-docusaurus:
-> linking to /faqs/
On source page path = /community/development/internal/transform:
-> linking to /faqs/
On source page path = /community/development/investigations:
-> linking to /faqs/
On source page path = /community/development/profiling:
-> linking to /faqs/
On source page path = /community/development/quick-start:
-> linking to /faqs/
On source page path = /community/development/testing:
-> linking to /faqs/
On source page path = /community/faqs:
-> linking to /faqs/
On source page path = /community/getting-started/about:
-> linking to /faqs/
On source page path = /community/getting-started/codecs:
-> linking to h/docs/artefacts/artefacts/postprocessors/#length-prefixerd (resolved as: /community/getting-started/h/docs/artefacts/artefacts/postprocessors/)
-> linking to /faqs/
On source page path = /community/getting-started/connectivity:
-> linking to /faqs/
On source page path = /community/getting-started/getting-started:
-> linking to /docs/workshop/examples/10_logstash/README
-> linking to /docs/workshop/examples/11_influx/README
-> linking to /faqs/
On source page path = /community/getting-started/install:
-> linking to /docs/development/quick-start/
-> linking to /faqs/
On source page path = /community/getting-started/scripting:
-> linking to /docs/tremor-script/#match (resolved as: /docs/tremor-script/)
-> linking to /docs
-> linking to /docs/tremor-query
-> linking to /docs/artefacts/operators
-> linking to /faqs/
On source page path = /community/getting-started/specialize:
-> linking to /docs/artefacts/operators#runtimetremor (resolved as: /docs/artefacts/operators)
-> linking to /docs/artefacts/operators#grouperbucket (resolved as: /docs/artefacts/operators)
-> linking to /docs/artefacts/operators#generic::backpressure (resolved as: /docs/artefacts/operators)
-> linking to /docs/artefacts/operators#generic::batch (resolved as: /docs/artefacts/operators)
-> linking to /docs/artefacts/operators#passthrough (resolved as: /docs/artefacts/operators)
-> linking to /docs/artefacts/operators#debughistory (resolved as: /docs/artefacts/operators)
-> linking to /docs/artefacts/
-> linking to /faqs/
On source page path = /community/getting-started/tooling:
-> linking to /faqs/
On source page path = /community/governance:
-> linking to /faqs/
On source page path = /community/governance/CII:
-> linking to /faqs/
On source page path = /community/governance/CodeofConduct:
-> linking to /docs/CodeOfConduct
-> linking to /faqs/
On source page path = /community/governance/Contributing:
-> linking to /docs/CodeOfConduct
-> linking to /docs/policies/security
-> linking to /docs/development/quick-start/
-> linking to /faqs/
On source page path = /community/governance/policies/security:
-> linking to /faqs/
On source page path = /community/teams:
-> linking to /faqs/
On source page path = /docs/artefacts/codecs:
-> linking to /faqs/
On source page path = /docs/artefacts/offramps:
-> linking to codecs.md#json (resolved as: /docs/artefacts/codecs.md)
-> linking to ./onramps.md#rest (resolved as: /docs/artefacts/onramps.md)
-> linking to ../operations/linked-transports.md (resolved as: /docs/operations/linked-transports.md)
-> linking to /faqs/
On source page path = /docs/artefacts/onramps:
-> linking to /faqs/
On source page path = /docs/artefacts/postprocessors:
-> linking to /faqs/
On source page path = /docs/artefacts/preprocessors:
-> linking to /faqs/
On source page path = /docs/ConstraintsLimitations:
-> linking to /faqs/
On source page path = /docs/glossary:
-> linking to /faqs/
On source page path = /docs/history:
-> linking to /faqs/
On source page path = /docs/index:
-> linking to /api
-> linking to /faqs/
On source page path = /docs/operations/cli:
-> linking to /faqs/
On source page path = /docs/operations/configuration:
-> linking to /faqs/
On source page path = /docs/operations/configuration-walkthrough:
-> linking to /faqs/
On source page path = /docs/operations/gdcb:
-> linking to /faqs/
On source page path = /docs/operations/linked-transports:
-> linking to /faqs/
On source page path = /docs/operations/monitoring:
-> linking to /faqs/
On source page path = /docs/overview:
-> linking to /faqs/
On source page path = /docs/recipes/bridges_lt_http_ws/README:
-> linking to /faqs/
On source page path = /docs/recipes/configurator/README:
-> linking to /faqs/
On source page path = /docs/recipes/filter/README:
-> linking to /faqs/
On source page path = /docs/recipes/grafana/README:
-> linking to /faqs/
On source page path = /docs/recipes/influx/README:
-> linking to /faqs/
On source page path = /docs/recipes/kafka_elastic_correlation/README:
-> linking to /faqs/
On source page path = /docs/recipes/kafka_gd/README:
-> linking to /faqs/
On source page path = /docs/recipes/logstash/README:
-> linking to /faqs/
On source page path = /docs/recipes/otel_elastic_apm/README:
-> linking to /faqs/
On source page path = /docs/recipes/otel_jaeger/README:
-> linking to /faqs/
On source page path = /docs/recipes/otel_passthrough/README:
-> linking to /faqs/
On source page path = /docs/recipes/otel_prometheus/README:
-> linking to /faqs/
On source page path = /docs/recipes/otel_zipkin/README:
-> linking to /faqs/
On source page path = /docs/recipes/passthrough/README:
-> linking to /faqs/
On source page path = /docs/recipes/persistent_gd/README:
-> linking to /faqs/
On source page path = /docs/recipes/polling_alerts/README:
-> linking to /faqs/
On source page path = /docs/recipes/postgres_timescaledb/README:
-> linking to /faqs/
On source page path = /docs/recipes/proxies_lt_http/README:
-> linking to /faqs/
On source page path = /docs/recipes/proxies_lt_ws/README:
-> linking to /faqs/
On source page path = /docs/recipes/quota_service/README:
-> linking to /faqs/
On source page path = /docs/recipes/README:
-> linking to /faqs/
On source page path = /docs/recipes/reverse_proxy_load_balancing/README:
-> linking to /faqs/
On source page path = /docs/recipes/roundrobin/README:
-> linking to /faqs/
On source page path = /docs/recipes/servers_lt_http/README:
-> linking to /faqs/
On source page path = /docs/recipes/servers_lt_ws/README:
-> linking to /faqs/
On source page path = /docs/recipes/syslog_udp_dns/README:
-> linking to ../14_syslog_udp/ (resolved as: /docs/recipes/14_syslog_udp/)
-> linking to /faqs/
On source page path = /docs/recipes/syslog_udp/README:
-> linking to /faqs/
On source page path = /docs/recipes/transform/README:
-> linking to /faqs/
On source page path = /docs/recipes/transient_gd/README:
-> linking to /faqs/
On source page path = /docs/recipes/validate/README:
-> linking to /faqs/
On source page path = /docs/tremor-query/functions:
-> linking to /faqs/
On source page path = /docs/tremor-query/functions/stats:
-> linking to /faqs/
On source page path = /docs/tremor-query/functions/win:
-> linking to /faqs/
On source page path = /docs/tremor-query/index:
-> linking to /faqs/
On source page path = /docs/tremor-query/modules:
-> linking to /faqs/
On source page path = /docs/tremor-query/operators:
-> linking to /faqs/
On source page path = /docs/tremor-query/pp:
-> linking to /faqs/
On source page path = /docs/tremor-query/recipes:
-> linking to /faqs/
On source page path = /docs/tremor-query/walkthrough:
-> linking to /faqs/
On source page path = /docs/tremor-script/extractors:
-> linking to /faqs/
On source page path = /docs/tremor-script/extractors/base64:
-> linking to /faqs/
On source page path = /docs/tremor-script/extractors/cidr:
-> linking to /faqs/
On source page path = /docs/tremor-script/extractors/datetime:
-> linking to /faqs/
On source page path = /docs/tremor-script/extractors/dissect:
-> linking to /faqs/
On source page path = /docs/tremor-script/extractors/glob:
-> linking to /faqs/
On source page path = /docs/tremor-script/extractors/grok:
-> linking to /faqs/
On source page path = /docs/tremor-script/extractors/influx:
-> linking to /faqs/
On source page path = /docs/tremor-script/extractors/json:
-> linking to /faqs/
On source page path = /docs/tremor-script/extractors/kv:
-> linking to /faqs/
On source page path = /docs/tremor-script/extractors/regex:
-> linking to /faqs/
On source page path = /docs/tremor-script/functions:
-> linking to /faqs/
On source page path = /docs/tremor-script/index:
-> linking to /docs/tremor-query/#select-queries (resolved as: /docs/tremor-query/)
-> linking to /faqs/
On source page path = /docs/tremor-script/modules:
-> linking to /faqs/
On source page path = /docs/tremor-script/pp:
-> linking to /faqs/
On source page path = /docs/tremor-script/recipes:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/cncf:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/cncf/otel:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/cncf/otel/logs:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/cncf/otel/logs/severity:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/cncf/otel/logs/traceflags:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/cncf/otel/metrics:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/cncf/otel/metrics/temporality:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/cncf/otel/span_id:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/cncf/otel/trace:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/cncf/otel/trace_id:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/cncf/otel/trace/spankind:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/cncf/otel/trace/status:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/std:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/std/array:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/std/base64:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/std/binary:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/std/float:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/std/integer:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/std/json:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/std/math:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/std/random:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/std/range:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/std/re:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/std/record:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/std/string:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/std/test:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/std/type:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/std/url:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/tremor:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/tremor/chash:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/tremor/origin:
-> linking to /faqs/
On source page path = /docs/tremor-script/stdlib/tremor/system:
-> linking to /faqs/
On source page path = /rfc/accepted/pipeline-state-mechanism:
-> linking to /faqs/
On source page path = /rfc/accepted/plugin-development-kit:
-> linking to wasmtime (resolved as: /rfc/accepted/wasmtime)
-> linking to /faqs/
On source page path = /rfc/accepted/ramp-interface:
-> linking to /faqs/
On source page path = /rfc/accepted/sliding-window-mechanism:
-> linking to /faqs/
On source page path = /rfc/implemented/circuit-breaker-mechanism:
-> linking to /faqs/
On source page path = /rfc/implemented/correlation:
-> linking to 0003-linked-transports/ (resolved as: /rfc/implemented/0003-linked-transports/)
-> linking to /faqs/
On source page path = /rfc/implemented/linked-transports:
-> linking to /faqs/
On source page path = /rfc/implemented/modularity:
-> linking to /faqs/
On source page path = /rfc/implemented/onramp-postgres:
-> linking to /faqs/
On source page path = /rfc/implemented/pipeline-optimizations:
-> linking to /faqs/
On source page path = /rfc/implemented/remove-actix-from-tremor-runtime:
-> linking to /faqs/
On source page path = /rfc/implemented/string-interpolation:
-> linking to /faqs/
On source page path = /rfc/index:
-> linking to process/libs_changes (resolved as: /rfc/process/libs_changes)
-> linking to process/0000-template/ (resolved as: /rfc/process/0000-template/)
-> linking to /faqs/
On source page path = /rfc/process/api_changes:
-> linking to /faqs/
On source page path = /rfc/process/arch_changes:
-> linking to /faqs/
On source page path = /rfc/process/lang_changes:
-> linking to /faqs/
On source page path = /rfc/process/lib_changes:
-> linking to /faqs/
On source page path = /rfc/process/template:
-> linking to /faqs/

No margins in benchmark page

This page doesn't have any margins: https://www.tremor.rs/benchmarks

favicon

We're missing a favicon to show in the browser's tab

Get specific about Getting Started

This is an extract from the Docs Assessment done by @celestehorgan

Getting Started Guides contain a very predictable set of content:
- In one paragraph or less, what is this piece of software
- What prerequisite software (i.e. Kubernetes) and knowledge (i.e., Go) do I need on my system to launch this?
- What special features does this piece of software have that other similar software might not have?
- What are the installation instructions?
- Is there a sample application I can set up and execute basic commands on?

Search bar too close to light/dark switch

The switch should have some padding like the other top-bar elements.

Update monitoring walk through and remove legacy `pipeline` yaml config

The system metrics walk through still refers to the legacy pipeline configuration field that
was deprecated with the introduction of trickle. The walkthrough should be updated to use
tremor and trickle files and reflect any format changes.

https://www.tremor.rs/docs/operations/monitoring

Create a CONTRIBUTING.md file for the docs repository

This is an extract from the Docs Assessment done by @celestehorgan

NOTE: we have this by now but it should be reviewed if it fits the web page standard

Update RFC port

Ensure that RFCs are up to date so we can close the old repository:

archive tremor-rs/tremor-rfcs
port delta
disable tremor-rs/tremor-rfcs

Links pinned to 0.12 don't work

I want to share links to documentation for the 0.12 version. If I linked to the next version, it would break as soon as a new one released. However, this only works for 0.11, apparently:

Works: https://www.tremor.rs/docs/0.11/overview
Works: https://www.tremor.rs/docs/next/getting-started/
Doesn't work: https://www.tremor.rs/docs/0.12/getting-started/ (the only difference is replacing next with 0.12 in the link)

Clashing colors on netlify banner

The netlify banner uses a background color that is close but not quite our footers color - this creates a very low contrast look that is quite unpleasant:

Lets find a banner that looks propper.

Typo: TDenbine in guides/index.md should be TDengine

IMO, the TDenbine in guides/index.md/ Technologies should be TDengine.

cover in dark mode and on small screens looks off

It seems to be transparent, probably messed up the color instead of gray went for transparent :) oopsie

Move Getting Started section out of community and into docs

The new website is AWESOME!! One change I would made:

Move https://www.tremor.rs/community/getting-started/getting-started to https://www.tremor.rs/docs/getting-started/getting-started

This is a very code-and-stuff based set of docs, so it needs to be in with the rest of the docs IMHO.

Reorganize the Operations section and retitle it "Using Tremor"

This is an extract from the Docs Assessment done by @celestehorgan

Additionally, move some topics from the existing Getting Started section:
- Configuring Tremor
- Walkthrough: Configure a Tremor Deployment
- Connectivity: Onramps and Offramps
- Link to the Onramps and Offramps sections to point users to their next steps
- Guaranteed Delivery (Note: this topic needs revision as it is not user friendly)
- Linked Transports
- Pipelines (Overview: what are pipelines? You can probably borrow content from the Pipeline Model section of the architecture overview)
- Create a Tremor Pipeline
- Specialize Tremor Pipelines
- Processing Data
- Recipes/Examples
- Monitoring
- Tremor CLI Tool
- IDE Add-ons

Governance drop-down does cannot be fully accessed when Getting-Started drop down is expanded.

See image above. When the Getting Started drop-down is expanded, the Governance drop-down can't fully expand, and the policies tab is inaccessible.

Language Reference rewrite for v0.12 release

Rewrite the language reference based on a lightweight code generation process
that leverages the language grammar for tremor written in LALRPOP rather than
using a hand maintained EBNF file and online railroad diagram generators.

The generator has been submitted to LALRPOP as a draft PR here: lalrpop/lalrpop#658

Broken img link for cncf log on FAQ page

Reported by Chris Fauerbach out of band

Redirect `docs.tremor.rs` to `www.tremor.rs/docs`

It'd be nice if someone could configure the domain to redirect docs.tremor.rs/<PATH> to www.tremor.rs/docs/<PATH> to not break previous links to the docs.

Copyright footer needs compliance

The current copyright footer is incorrect per the licenses that CNCF usually uses. It should (probably) be the following:

© 2020-2021 Tremor Authors | Documentation Distributed under CC-BY-4.0

© 2021 The Linux Foundation. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Usage page.

Imprecise documentation for the `string` module

There are certain things that are unclear in the documentation of the string module (https://www.tremor.rs/docs/next/scripting/tremor-script/stdlib/std/string)

len, capitalize, substr - the description refers to characters, without defining what a character is (is it a codepoint? a grapheme group?)
trim, trim_start, trim_end - does not define which characters are considered to be whitespace
lowercase, uppercase, capitalize - does not define the locale for which the strings are upper/lowercased, matters for example for the Turkish language (https://en.wikipedia.org/wiki/Dotted_and_dotless_I)
from_utf8_lossy - it mentions only invalid codepoints, what about other potential problems (e.g. trailing combining characters)? Will those be left as is?

Develop a case study or other content around Wayfair's use of Tremor

This is an extract from the Docs Assessment done by @celestehorgan

to give users a tangible example of what they can do with the project

Audit for colloquial/casual language, abbreviations, and other "basic" English

This is an extract from the Docs Assessment done by @celestehorgan

This recommendation has less to do with casual language or abbreviations being bad, and more to do with the perception of professionalism for the project.
Review all documentation for the following:
- Unnecessary abbreviations (for example This page).
- Casual language or colloquialisms, for example: A short "canned" synopsis, referring to processes either as painless (on the same page: "let's be real"), etc.
- Spelling, consistent capitalization of titles, consistent verbiage in titles:
  - In general when it comes to page titles, prefer either proper nouns (Good examples of this: Lexical Preprocessor, Linked Transports), or verb-based phrases for tasks (For example, Debugging with LLDB).

consider RFC signoff requirements

Currently, RFCs state the following requirement

Before actually entering FCP, *all* members of the subteam must sign off; 
this is often the point at which many subteam members first review the RFC

This can become problematic if a subteam member becomes unavailable, due to vacation, health, or personal reasons. It is worth considering how to phrase this requirement in a way that is accommodating for team members' lives and other unforeseen circumstances.

Add language rfc getting started guide for first time language rfc contributors

We failed to provide guidance from the first time contributor perspective for assumptions,
conventions, considerations and constraints/limitations that would be a huge benefit to the
successful submission of a language RFC with minimal review round trips.

This is a process failure ( our fault ) and was brought to our attention in this issue:

#118

Note from/to maintainers: This is a tracking issue to ensure the guidance ( now WIP ) is not forgotten now that the need has been captured.

Render tremor-cli man-pages in docs

We recently lost the cli.yaml command line definintion that we created the cli documentation from.

With https://crates.io/crates/clap_mangen we have a crate to create manpages for us, even without any yaml. It would be nice to have them rendered as HTML or .md files in our docs.

Update docs port

Update docs to ensure they're up to date

archive tremor-rs/tremor-www-docs
update content
disable tremor-rs/tremor-www-docs

Go over alex suggestions and improve inclusiveness of the page

Alex has a number of suggestions, we should go over them and clean that up.

On the new website, the tremor icon is squashed when the window is not wide enough

The image of the logo at the top left corner of the page disappears when the window is quite narrow, and looks as expected when the window is wide enough, but in between those two extremes it is distorted. I was viewing on the current build of Microsoft Edge, and the problem reproduced with the current version of chrome too., both on a recent insider build of Windows 11.

tremor-rs / tremor-www Goto Github PK

tremor-www's Introduction

Installation

Prerequisites/Dependencies

Development

Running the Website

Syntax Highlighting

tremor-www's People

Contributors

Stargazers

Watchers

Forkers

tremor-www's Issues

Missing preprocessors:

Incorrectly listed preprocessors:

Missing postprocessors:

Incorrectly listed:

Recommend Projects

Recommend Topics

Recommend Org