search

lightbend / sbt-paradox-project-info

A Paradox directive to include standardised project information into the generated documentation
Apache License 2.0
5 stars 5 forks source link

Definitions #3

Open rstento opened 6 years ago

rstento commented 6 years ago

This looks great, and will be very helpful to our users. Looking at the example posted in the email: image

It might be good to have an asterisk by Java Versions and Scala Versions that links to a definition of what we mean by "supported" versions. And, this matrix will be much more complicated for products such as the Lightbend Console and Fast Data Platform, might be good to think about their requirements too.

ennru commented 5 years ago

Yes, especially for the readiness levels I expect us to show their definitions on the Lightbend web site. This is what our use in Alpakka needed, let's take it from here.

ennru commented 5 years ago

We've now updated the Alpakka Kafka site which uses this plugin. What do you think is the best way to explain the rows?

  1. Link on the header to lightbend.com
  2. Asterisk with explanations below
  3. Small explanation text in the same cell
  4. Other