wildfly-extras / wildfly-datasources-galleon-pack

WildFly Feature Pack for DataSources
Apache License 2.0
21 stars 18 forks source link

Documentation (README) improvements #165

Closed bstansberry closed 1 year ago

bstansberry commented 1 year ago

I believe the various README.md files are the basic documentation for this software. Some suggestions:

1) More content on the top level README about how to use these, e.g. a simple discussion of what a Galleon feature pack is, links to other content (e.g. some of the WildFly installation guides and general Galleon docs content) and a discussion of what base feature pack(s) the FPs from this project are meant to work with.

2) Mention of common architectural points, i.e. that for each database type the FP provides 3 Galleon layers that build upon each other -- one just to add the driver, one that builds on the first to add a datasource, one that builds on the second to make the datasource the Jakarta EE default datasource.

3) In the Datasources section a bit of an intro paragraph that explains that the linked READMEs provide info about how to use the FP to work with each of the listed drivers. Currently it's just driver names that are links but I have no idea what to expect if I click on the link.