From 9f5100d5672925af82eb24c1737c675801e77e9c Mon Sep 17 00:00:00 2001 From: Timm Heuss Date: Sun, 30 Jul 2023 22:33:41 +0200 Subject: [PATCH] Update documentation --- architecture.drawio | 46 ++++++++++++++++++++++++++--------------- architecture.drawio.svg | 2 +- index.de.md | 2 +- index.en.md | 5 +++-- 4 files changed, 34 insertions(+), 21 deletions(-) diff --git a/architecture.drawio b/architecture.drawio index 407e6c0..546baf8 100644 --- a/architecture.drawio +++ b/architecture.drawio @@ -1,6 +1,6 @@ - + - + @@ -20,7 +20,7 @@ - + @@ -56,15 +56,18 @@ - + - + + + - + - + + @@ -75,10 +78,10 @@ - + - + @@ -170,34 +173,43 @@ - + - + - + - + - + - + - + - + + + + + + + + + + diff --git a/architecture.drawio.svg b/architecture.drawio.svg index 88c8d51..2ab9f7f 100644 --- a/architecture.drawio.svg +++ b/architecture.drawio.svg @@ -1,4 +1,4 @@ -
article-urls
article-...
rss-feed-feeder
rss-feed...
keyword-matcher
keyword-...
match-urls
match-ur...
pocket-integration
pocket-i...
getpocket.com
getpoc...
8x
8x
keywords.txt
key...
Load Balancer
fullfeedrss
fullfeed...
2x
2x
nats-serverLoki
prometheus-nats-exporter
promethe...
urls.txt
url...
feed-urls
feed-urls
rss-article-url-feeder
rss-arti...
6x
6x
Text is not SVG - cannot display
\ No newline at end of file +
article-urls
article-...
rss-feed-feeder
rss-feed...
keyword-matcher
keyword-...
match-urls
match-ur...
pocket-integration
pocket-i...
getpocket.com
getpoc...
8x
8x
keywords.txt
key...
Load Balancer
fullfeedrss
fullfeed...
2x
2x
nats-serverLoki
prometheus-nats-exporter
promethe...
urls.txt
url...
feed-urls
feed-urls
rss-article-url-feeder
rss-arti...
6x
6x
raindrop.io
raindrop-integration
raindrop...
Text is not SVG - cannot display
\ No newline at end of file diff --git a/index.de.md b/index.de.md index 828d852..e386155 100644 --- a/index.de.md +++ b/index.de.md @@ -3,7 +3,7 @@ Title: Persönliche Nachrichtenanalyse summary: Findet automatisch relevante Nachrichten aus dem Web. --- -Fragt systematisch Online-Nachrichtenartikel ab, reichert sie an, sucht nach Schlagworten und sendet Treffer zu [GetPocket.com](https://getpocket.com/). Alle Komponenten sind lose mit [NATS.io](https://nats.io/) work queues gekoppelt, was es auch erlaubt, Single-Core-CPU-intensive Komponenten einfach zu skalieren. +Fragt systematisch Online-Nachrichtenartikel ab, reichert sie an, sucht nach Schlagworten und sendet Treffer zu [raindrop.io](https://raindrop.io/) / [GetPocket.com](https://getpocket.com/). Alle Komponenten sind lose mit [NATS.io](https://nats.io/) work queues gekoppelt, was es auch erlaubt, Single-Core-CPU-intensive Komponenten einfach zu skalieren. ![](architecture.drawio.svg) diff --git a/index.en.md b/index.en.md index 19907e1..bc75500 100644 --- a/index.en.md +++ b/index.en.md @@ -3,7 +3,7 @@ Title: Personal News Analysis summary: Automatically find relevant news from the Web. --- -Systematically retrieves online news articles, enriches them, scans them for keywords and sends hits to [GetPocket.com](https://getpocket.com/). All analysis components are loosely-coupled with [NATS.io](https://nats.io/) work queues, which also allows scaling single-core-CPU-intensive components easily. +Systematically retrieves online news articles, enriches them, scans them for keywords and sends hits to [raindrop.io](https://raindrop.io/) / [GetPocket.com](https://getpocket.com/). All analysis components are loosely-coupled with [NATS.io](https://nats.io/) work queues, which also allows scaling single-core-CPU-intensive components easily. ![](architecture.drawio.svg) @@ -24,7 +24,8 @@ All services are orchestrated and scaled with `docker-compose.yml`. - [ghcr.io/heussd/nats-news-analysis/rss-feed-feeder](https://ghcr.io/heussd/nats-news-analysis/rss-feed-feeder) - **Bash** - Feeds rss feed urls from a text file. - [ghcr.io/heussd/nats-news-analysis/rss-article-url-feeder-go](https://ghcr.io/heussd/nats-news-analysis/rss-article-url-feeder-go) - **Golang** - Feeds news articles from RSS feeds. - [ghcr.io/heussd/nats-news-analysis/keyword-matcher-go](https://ghcr.io/heussd/nats-news-analysis/keyword-matcher-go) - **Golang** - Matches against keywords list. -- [ghcr.io/heussd/nats-news-analysis/pocket-integration](https://ghcr.io/heussd/nats-news-analysis/pocket-integration) - **Python** - Feeds matches into getpocket.com. +- [ghcr.io/heussd/nats-news-analysis/pocket-integration](https://ghcr.io/heussd/nats-news-analysis/pocket-integration) - **Python** - Publishes matches on [getpocket.com](https://getpocket.com/). +- [ghcr.io/heussd/nats-news-analysis/raindrop-integration](https://ghcr.io/heussd/nats-news-analysis/raindrop-integration) - **Golang** - Publishes matches on [raindrop.io](https://raindrop.io/). ### Third party services