"Enhance Adoptium Migration Collateral" Project Proposal - Eclipse Adoptium

About Our Organization

The mission of Eclipse Adoptium is to produce high-quality runtimes and associated technology for use within the Java ecosystem. We achieve this through a set of Projects under the Adoptium PMC and a close working partnership with external projects, most notably OpenJDK for providing the Java SE runtime implementation. Our goal is to meet the needs of both the Eclipse community and broader runtime users by providing a comprehensive set of technologies around runtimes for Java applications that operate alongside existing standards, infrastructures, and cloud platforms.

Formerly known as the AdoptOpenJDK project, it was established in 2017 following years of discussions about the general lack of a community-based distribution of OpenJDK and an open and reproducible build and test system for OpenJDK source across multiple platforms. Since then it has grown to become a leading provider of high-quality OpenJDK-based binaries used by enterprises in embedded systems, desktops, traditional servers, modern cloud platforms, and large mainframes. Please find more details at https://adoptium.net/about/.

About Our Project

Our Project's Problems

• Adoptium produces Eclipse Temurin, a distribution of OpenJDK.
• Adoptium provides migration documentation for users wishing to migrate from OracleJDK to Eclipse Temurin (https://adoptium.net/docs/migration/)
• The documentation needs a significant additions to further explain each of the points, and to address user questions that aren’t currently addressed by the documentation, such as https://www.eclipse.org/lists/temurin-dev/msg00030.html

Our Project's Scope

• Create how-to documentation, and improve existing migration documentation for the following points:
  • Java WebStart
  • JavaFX
  • T2K Font Rendering
  • Monotype Lucida Fonts
  • Ductus 2D Renderer
  • Kodac Color Matching System library
  • SNMP
  • Sound drivers
  • JFR
  • JMC
• There is an old migration document that can be referenced (but needs major overhaul since it pre-dates our move to Eclipse Foundation and rebranding effort from AdoptOpenJDK to Adoptium / Temurin).
• Revise the presentation and organization of the newly written migration documentation to be easy to walkthrough
• Verify the new instructions are accurate and usable by someone in the midst of migration from a different provider to Temurin
• Ideally documentation will also provide several diagrams and visual components beyond text-based documentation as a portion of the consumer base may not have English as a first language
• The website has the capacity to support multiple languages. The scope of this work does not include translations to other language, but may include the raising of enhancement issues to invite the community to help provide curated translations of key components of new documentation.

Measuring Our Project's Success

• Success will be measured via feedback requests from the community, as well as user-driven testing of the how-to documentation, where community members will try to work through the new documentation in attempting mock migration.

Timeline

• The project will take about 6 months to complete. Each section of documentation (~10) to be touched is well-defined and we expect an average of two weeks for each, with some taking more time, and others taking less time. The overall presentation and organization of all of the how-tos will also need to be addressed
• The timeline will look as following:
  • May: Orientation to the project, onboarding into the community, review of the existing documentation, and discussion of issues to be addressed
  • June - September: Technical Writer contributions to update the migration of documentation alongside our mentor, with review of state, and adjustment of work as we progress through two week based sprint iterations
  • October - November : Offboarding of the project, tying off loose ends for a coherent end result, and reviewing the work done and preparing the case study

Project Budget

The project will have one mentor for the project and would request one technical writer to work with us. We will also enlist volunteers to help step through draft documentation to ensure it is clear and successfully guides volunteers through a mock migration. We request $5500 USD for this work.

Budget Item	Amount	Running Total	Notes/Justifications
Technical writer updates, reviews, edits, and publishing new documentation	$5000	$5000
Swag for volunteers	$500	$5500	Provide caps & stickers for volunteers
Total		$5500

Additional Information

The project does not have experience of working with technical writers at the open-source project, though some mentors have worked with documentation teams within their corporations. Some mentors have participated in Google Summer of Code. Regular interlocks and a dedicated communication channel in Slack worked well for answering questions and ensuring the participants progressed well during their term.