spring-cloud-aws icon indicating copy to clipboard operation
spring-cloud-aws copied to clipboard

Improve documentation to have Java configuration instead of XML only

Open tiarebalbi opened this issue 2 years ago • 3 comments

Type: Feature (Documentation)

Is your feature request related to a problem? Please describe. Today, most of the documentation describe how to configure the beans using XML, the request here is to introduce a similar integration as the spring boot doc provides, and support different type of configurations in the doc.

Example:

  • https://docs.spring.io/spring-framework/docs/current/reference/html/data-access.html#jdbc-embedded-database-java

Describe the solution you'd like Keep the XML documentation but support Java configuration and potentially Kotlin.

tiarebalbi avatar Jul 05 '22 09:07 tiarebalbi

I understand your point. That's why for 3.0 we moved completely from XML config: https://docs.awspring.io/spring-cloud-aws/docs/3.0.0-SNAPSHOT/reference/html/index.html

We - the core team - are not going to put effort into improving docs for 2.x since 3.0 is coming later this year and this is our area of focus, but if you would like to improve docs for 2.x - PRs are welcome.

maciejwalkowiak avatar Jul 05 '22 12:07 maciejwalkowiak

Thanks @maciejwalkowiak , yes that was going to be my suggestion I'm working on a project where I'm writing the Java config for most of the topics covered in the documentation.

Happy to prepare a PR with these changes.

tiarebalbi avatar Jul 05 '22 20:07 tiarebalbi

@tiarebalbi do you think it will happen or should i close it?

maciejwalkowiak avatar Sep 02 '22 13:09 maciejwalkowiak

Closing due to lost interest ;-)

maciejwalkowiak avatar Jan 28 '23 20:01 maciejwalkowiak