RFR: Split up monolithic markdown

Jesper Wilhelmsson jwilhelm at openjdk.java.net
Tue Mar 16 14:12:30 UTC 2021


On Mon, 15 Mar 2021 20:03:36 GMT, Magnus Ihse Bursie <ihse at openjdk.org> wrote:

> The original Developer's Guide was split into one html page per chapter. This was (rightly so) combined into a single html page previously by Jesper.
> 
> However, this also means that we got a single, monolithic markdown file to edit. This makes the file unnecessarily hard to navigate and edit.
> 
> This patch will instead split up the original index.md file into separate markdown documents, one per chapter. At build time, they are recombined into a single index.md file again (exactly identical with the one I started with).
> 
> This patch depends on https://github.com/openjdk/guide/pull/46.

Continuing the erroneously placed discussion from PR #46:
> I don't mind this change but...

If we want to future-proof this and make it a stable foundation we shouldn't have chapter numbers in the file names. I don't want to rename all chapters just because a new one is inserted or removed somewhere. Also, since we are quite early in the making of this document it's likely that chapters will move within the guide as well.

-------------

PR: https://git.openjdk.java.net/guide/pull/47


More information about the guide-dev mailing list