binkley / modern-java-practices

Modern Java/JVM Build Practices
Other
933 stars 69 forks source link

Provide consistent sections for each page #464

Closed binkley closed 2 months ago

binkley commented 4 months ago

Context

The wiki-outline.py script exposes gaps and inconsistencies in how pages are structured.

Standard structure

A potential standard structure:

  1. Why and General; motivation (not JVM-specific, but about the value)
  2. Sample build script code in the writing? Or better to refer to the code repo with line numbers? (Line numbers are helpful but annoying to maintain)
  3. Specific to JVM (JVM, Gradle and Maven)
  4. Spots to insert advice for other build tools & language ecosystems -- TO DISCUSS
  5. Tips
  6. Going further

Acceptance criteria

Out of scope

Tasks

These depend on agreement on standard structure.

More than Gradle/Maven

Prepare for the sections being expandable for other build tools/platforms/languages. TO DISCUSS

Separate each section into General advice, and advice Specific to JVM. Add a Discussion section to break up advice from why and discussion.

binkley commented 2 months ago

I added "Going further" at page bottom when sensible for example skipping front/end matter pages.