RFR: Cleaning up headers and examples [v2]

[Jesper Wilhelmsson]

On Thu, 1 Sep 2022 10:48:21 GMT, Alexey Ivanov <aivanov at openjdk.org> wrote:

>> Jesper Wilhelmsson has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   Update src/guide/mailing-lists.md
>>   
>>   Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk at users.noreply.github.com>
>
> 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.

Fixed.

> 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.

Good catch!

> 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?

No, currently only first level headers are capitalized in this document.

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

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