spring-cloud / stream-applications

Functions and Spring Cloud Stream Applications for data driven microservices
https://spring.io/projects/spring-cloud-stream-applications
250 stars 106 forks source link

[Docs] Improve docs around stream apps table #477

Closed onobc closed 3 months ago

onobc commented 1 year ago

Duplication

There is a table that lists the available stream apps and it is in multiple locations:

This duplication leads to inconsistency across locations and is toil to attempt to keep the table up-to-date.

Formatting

In addition to the duplication, the table layout is currently confusing. There is a 3 column table (source, processor, sink). Each column is alpha-ordered but there is also an attempt to line up rows that have representation in more than 1 column (eg. xmpp, twitter, etc..). It may be less confusing to instead break the 3 column table into 3 separate lists (one for source, processor, sink) and just make them alpha-ordered.

[!NOTE] The spring-functions-catalog is already using this single column format.

artembilan commented 1 year ago

+1 for a list representation: there is no guarantee that we always going to have close number of those sources, processors and sinks. I also don't think that it would be a big deal to have these lists in a separate adoc file to be include:: whenever it is necessary.

Indeed such a file could be generated: I believe I can write some Gradle task simply based on Groovy File API, but I don't think it would be possible with Maven without custom plugin or so...

onobc commented 1 year ago

Indeed such a file could be generated: I believe I can write some Gradle task simply based on Groovy File API, but I don't think it would be possible with Maven without custom plugin or so...

I was thinking the same thing. Even w/o the auto-generation, the other 2 points would be a big improvement.

onobc commented 3 months ago
artembilan commented 3 months ago

Fixed via: https://github.com/spring-cloud/stream-applications/commit/e4143370eb8d0f1c485088e685519056b68acba3