Call for Discussion: New Project: Developer's Guide

[Jesper Wilhelmsson]

Hi Netroby.

As the project will be an OpenJDK project we will use the same infrastructure as all other OpenJDK projects. Contributions will be handled in the same fashion as in other OpenJDK projects through reviews and pushes made by Contributors in the project.

There are some best practices in place already for how to handle markdown and documentation in OpenJDK so we'll likely follow that as well.

Cheers,
/Jesper

> On 1 Apr 2020, at 10:38, Netroby <hufeng1987 at gmail.com> wrote:
> 
> How about create a git repository, using some document tools, like
> facebook/docusaurus.
> Then every one can easy contribute to the guide, and add I18n translate.
> 
> Appreciate your time.
> ----------------------------
> Netroby
> 
> Timmy Jose <zoltan.jose at gmail.com> 于2020年4月1日周三 下午2:37写道：
>> 
>> I think that this is a brilliant idea. The existing developer guide is
>> indeed very outdated, and an up-to-date, easy-to-locate guide is definitely
>> required. It would make things so much easier for people new to the process
>> such as myself. If possible, I would also like to be part of this
>> initiative - maybe it would also help
>> me get onboarded myself.
>> 
>> Best,
>> 
>> Timmy
>> 
>> On Tue, Mar 31, 2020 at 5:01 AM Jesper Wilhelmsson <
>> jesper.wilhelmsson at oracle.com> wrote:
>> 
>>> Hi Mohammed.
>>> 
>>> I'm happy to hear that you are interested in this project. The next step
>>> is the vote that has been initiated now. All Members of the OpenJDK have a
>>> vote and if they approve to creating the project it will be created. Once
>>> the project is in place we can start discussing the future.
>>> 
>>> Thanks,
>>> /Jesper
>>> 
>>>> On 29 Mar 2020, at 11:43, Mohammed Al-Moayed <mohammed.moayed at gmail.com>
>>> wrote:
>>>> 
>>>> Hi All
>>>> 
>>>> I am interested to be part of this.
>>>> 
>>>> Please, let me know next steps
>>>> 
>>>> Regards
>>>> Mohammed Almo
>>>> 
>>>>> On Mar 12, 2020, at 2:51 AM, Jesper Wilhelmsson <
>>> jesper.wilhelmsson at oracle.com> wrote:
>>>>> 
>>>>> Hi.
>>>>> 
>>>>> I would like to discuss the possible creation of the Developer's Guide
>>> Project
>>>>> with myself, Jesper Wilhelmsson, as the lead and the Core-Libs,
>>> Compiler, and
>>>>> Hotspot groups as the sponsoring Groups.
>>>>> 
>>>>> The initial goal of the project would be to create up-to-date
>>> guidelines for
>>>>> OpenJDK development and contributions. The intent is to update the
>>> existing
>>>>> OpenJDK Developer's Guide [1] which hasn't been updated since 2012.
>>> Parts of
>>>>> the existing guide are in need of updates while other parts are yet to
>>> be
>>>>> written. The initial source code for this project will be based on the
>>> current
>>>>> OpenJDK Developer's Guide.
>>>>> 
>>>>> In more recent years some process related information has been
>>> published on the
>>>>> OpenJDK wiki [2], but this information was never reviewed or approved
>>> by the
>>>>> community. Even though large parts of this information may be accurate,
>>> it needs
>>>>> to go through proper review before it can be seen as official
>>> guidelines for
>>>>> OpenJDK development.
>>>>> 
>>>>> Once the initial goal has been reached the project will transition into
>>> a
>>>>> maintenance project to keep the OpenJDK Developer's Guide up to date.
>>>>> 
>>>>> The OpenJDK Developer's Guide is intended to contain tutorial style
>>> texts that
>>>>> give examples and step-by-step directions for common parts of the
>>> development
>>>>> process. Strict rules for OpenJDK development are better suited to a
>>> process
>>>>> JEP. The development of such a JEP is outside of the scope of this
>>> project but
>>>>> will be developed as part of a separate effort in parallel.
>>>>> 
>>>>> Initial committers of the Developer's Guide Project include Mark
>>> Reinhold, Iris
>>>>> Clark, and Jesper Wilhelmsson. Additional committers may be identified
>>> through
>>>>> this discussion.
>>>>> 
>>>>> The project will host at least one mailing list,
>>> guide-dev at openjdk.java.net,
>>>>> for discussions and reviews of changes.
>>>>> 
>>>>> Thanks,
>>>>> /Jesper
>>>>> 
>>>>> [1] http://openjdk.java.net/guide/
>>>>> [2] https://wiki.openjdk.java.net/
>>>>> 
>>> 
>>>