Closed malcyon closed 2 years ago
Just a suggestion: the 3 images are similar in certain ways (Debian, Java, etc.), so it'd look a bit better if their descriptions had a consistent structure.
Just a suggestion: the 3 images are similar in certain ways (Debian, Java, etc.), so it'd look a bit better if their descriptions had a consistent structure.
Do you mean like moving the parts where it discusses Debian/Java up to the top of the section and make it clear it refers to all of them, so it's only in one place? Or by consistent structure, do you mean something like a table?
Do you mean like moving the parts where it discusses Debian/Java up to the top of the section and make it clear it refers to all of them, so it's only in one place? Or by consistent structure, do you mean something like a table?
I mainly meant that certain wording is unnecessarily different between image descriptions. For example:
The standard image runs on Debian and Java 8. There are also ARM64 and Java 11 variants.
versus
It's using Debian and Java 8. There are ARM64 and Java 11 variants as well.
Also, graylog-forwarder
doesn't mention that it's Debian- and Java-based.
I just find reading the exact same thing over and over a little tiresome, so I tried to change it up. Let me just move it around so it's only there once.
That's a little cleaner, I think? It doesn't have to be 100% perfect, but readability is important, since we may only get 2-3 seconds of someone's time as they're glancing over it.
Since this repository now builds three separate images, I thought it would be appropriate to detail that in the Readme. I also added a mention of our docker-compose template.