search

spring-cloud / stream-applications

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

Ensure functions are documented once #524

Closed onobc closed 4 months ago

onobc commented 5 months ago

Now that the functions have moved to spring-functions-catalog we need to update the function related documentation in each application as follows.

For each application, update the README.adoc by replacing the currently generated configuration properties w/ a link that points to its respective function configuration options.

As an example consider the file-sink app and its usage of spring-file-consumer function.

The file-sink README currently looks like:

Screenshot 2024-03-18 at 09 41 08

and the "Options" sections will instead simply be a link that points to the respective function catalog docs - https://github.com/spring-cloud/spring-functions-catalog/tree/main/consumer/spring-file-consumer#configuration-options in above example.

artembilan commented 5 months ago

I went ahead and cleaned READMEs in SFsC: https://github.com/spring-cloud/spring-functions-catalog/commit/77112eb8a1f66f0c9d11e7d6908bea6abb4f9db0

onobc commented 4 months ago

Closed via https://github.com/spring-cloud/stream-applications/commit/7487dc8f6161e8f3a10232fd4ebce8504e0fcd7f