RFR: Cleaning up headers and examples

Alexey Ivanov aivanov at openjdk.org
Thu Sep 1 10:58:28 UTC 2022


On Mon, 22 Aug 2022 15:22:54 GMT, Jesper Wilhelmsson <jwilhelm at openjdk.org> wrote:

> * Make all headers follow the same style
> * Make code examples use ~~~ instead of four space indentation
> * Fix email adresses to be actual adresses
> * Add link to jtreg FAQ
> * Add comment about the name space for noreg-labels

src/guide/mailing-lists.md line 26:

> 24: 
> 25: > `-discuss`
> 26: > :    General discussions around the project. The special case `discuss at openjdk.org` is used for general discussions around OpenJDK. Discussions around new project proposals usually happens here.

Suggestion:

> :    General discussions around the project. The special case `discuss at openjdk.org` is used for general discussions around OpenJDK. Discussions around new project proposals usually happen here.

src/guide/testing-the-jdk.md line 61:

> 59: ~~~
> 60: @requires docker.support
> 61: @requires os.family != ”windows”

Suggestion:

@requires os.family != "windows"

The quotes should be plain for easier copy-and-paste.

src/guide/working-with-the-legacy-mercurial-servers.md line 222:

> 220: In order to push changesets into the parent repository, some additional configuration is required. The following sections describe the operations that will be performed by users with push access.
> 221: 
> 222: ### Get your SSH key installed

Should this header use title capitalisation as other headers, at least in this review?

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

PR: https://git.openjdk.org/guide/pull/90


More information about the guide-dev mailing list