Migrate "installation" documentation to Asciidoc

hendrikebbers commented 3 years ago

🆕🐥 First Timers Only

This issue is reserved for people who never contributed to Open Source before. We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you 💝

👾 Description of the issue

The installation documentation of AdoptOpenJDK that can be found at https://adoptopenjdk.net/installation.html must be migrated to Temurin and stored as Asciidoc documentation in this repository.

📋 Step by Step

To solve this issue and contribute a fix you should check the following step-by-step list. A more detailed documentation of the workflow can be found here.

[x] Claim this issue: Comment below.
[x] Fork the repository in github by simply clicking the 'fork' button.
[x] Check out the forked repository
[x] Create a feature branch for the issue. We do not have any naming definition for branches.
[x] Commit your changes.
[x] Start a Pull Request.
[x] Done 👍 Ask in comments for a review :)
[x] If the reviewer find some missing peaces or a problem he will start a discussion with you and describe the next steps how the problem can be solved.
[x] You did it 🎉 We will merge the fix in the master branch.
[x] Thanks, thanks, thanks for being part of this project as an open source contributor ❤️

🎉 Contribute to Hacktoberfest

Solve this issue as part of the Hacktoberfest event and get a change to receive cool goodies like a T-Shirt. 🎽

🤔❓ Questions

If you have any questions just ask us directly in this issue by adding a comment. You can join our community chat at Slack. Next to this you can find a general manual about open source contributions here.

MBoegers commented 2 years ago

I'd like to work on this.

MBoegers commented 2 years ago

I've two questions:

In the other migration issues you've linked the adoptium.net pages. Should I migrate the more verbose Adoptopenjdk page or the less verbose adoptium.net installation page?
Both pages contain a dynamic part. That's not possible with static sites. I see two options:
1. three seperate, OS specific sections
2. embed non static content

I'd prefer the three sections, because they are easier to maintain.

hendrikebbers commented 2 years ago

PR: https://github.com/AdoptOpenJDK/website-adoptium-documentation/pull/24

hendrikebbers commented 2 years ago

As far as I know the 'dynamic' part only switches between 2 doc sections (for Windows X64 or other one) (src can be found here: https://github.com/adoptium/adoptium.net/blob/main/src/handlebars/installation.handlebars). So it is fine to first of all add all documentation in one file. I assume it must be restructured anyway in future.

hendrikebbers commented 2 years ago

@MBoegers does the PR contains all content?

hendrikebbers commented 2 years ago

Hi @MBoegers maybe you want to join the meetings for this project: https://github.com/AdoptOpenJDK/website-adoptium-documentation/issues/25

MBoegers commented 2 years ago

As far as I know the 'dynamic' part only switches between 2 doc sections (for Windows X64 or other one) (src can be found here: https://github.com/adoptium/adoptium.net/blob/main/src/handlebars/installation.handlebars). So it is fine to first of all add all documentation in one file. I assume it must be restructured anyway in future.

The Section in installation.handlebars does more, based on the selection of Version, JVM and Plattform it injects:

the correct direct download link
the correct file names into the listings
and switches between unix and windows installations

With #24 I propose a more generic, less dynamic way in lines 17 to 75.

@MBoegers does the PR contains all content?

Yes, the https://adoptium.net/installation.html[Adoptium.net installation] page only contains text and no other resources.

adoptium / documentation

Migrate "installation" documentation to Asciidoc #6