Giter Club home page Giter Club logo

documentation's Introduction

website-adoptium-documentation

This contains the new documentation for adoptium.net.

The documentation is based on asciidoc. An html documentation can be created by calling the build.sh script on linux or mac. To do so asciidoctor needs to be installed on the system.

Structure of the repository

Each documentation topic is defined by a folder that is named by the topic (technical name). Each folder contains the Asciidoc files (*.adoc) and resources like images that belong to the topic. General resources that will be used in several topics should be stored in a special folder named β€œshared”.

repo structure

Since we want to support i18n directly from the beginning a folder can contain multiple AsciiDoc files in different languages. The index.adoc file should always be part of a folder and should contain the english documentation. This will be the default language that will be used if the requested language is not available. The AsciiDoc file for a specific language is called index_XX.adoc where XX defines the iso code of the language that is used in the file.

folder structure

A common problem in documentation is the reuse and modification of images and diagrams. Therefore draw.io should be used wherever possible to create illustrations that are needed for the documentation. Next to this SVG should be used whenever possible instead of using pixel based images. For such pixel based images PNG should be used and such images should have a transparent background.

shared resources structure

documentation's People

Contributors

ckeibel avatar gdams avatar hendrikebbers avatar mboegers avatar smlambert avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

documentation's Issues

Migrate "installation" documentation to Asciidoc

πŸ†•πŸ₯ 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.

  • Claim this issue: Comment below.
  • Fork the repository in github by simply clicking the 'fork' button.
  • Check out the forked repository
  • Create a feature branch for the issue. We do not have any naming definition for branches.
  • Commit your changes.
  • Start a Pull Request.
  • Done πŸ‘ Ask in comments for a review :)
  • 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.
  • You did it πŸŽ‰ We will merge the fix in the master branch.
  • 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.

Provide documentation about Eclipse ECA sign-off status

πŸ†•πŸ₯ 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

Adoptium and all it repos belong to the Eclipse Foundation since Adoptium is a top level project at Eclipse. To contribute to an Eclipse project the Eclipse Contributor Agreement must be (digitally) signed. To do so an account at Eclipse is needed. The ECA is checked at GitHub in each pull request. Eclipse provides some general information regarding GIT and ECA but it would make sense to have a newcomer friendly documentation that is made directly for GitHub and pull requests.
Additional Information can be found here and here.
The goal of this issue is to provide a tutorial / step by step guide for newcomers as an adoc in this repo.

πŸ“‹ 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.

  • Claim this issue: Comment below.
  • Fork the repository in github by simply clicking the 'fork' button.
  • Check out the forked repository
  • Create a feature branch for the issue. We do not have any naming definition for branches.
  • Commit your changes.
  • Start a Pull Request.
  • Done πŸ‘ Ask in comments for a review :)
  • 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.
  • You did it πŸŽ‰ We will merge the fix in the master branch.
  • 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.

Migrate the "BumbleBench and HumbleBench" document

πŸ†•πŸ₯ 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 documentation regarding the BumbleBench benchmark can be found at https://github.com/adoptium/bumblebench/wiki/BumbleBench-and-HumbleBench The documentation must be migrated 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.

  • Claim this issue: Comment below.
  • Fork the repository in github by simply clicking the 'fork' button.
  • Check out the forked repository
  • Create a feature branch for the issue. We do not have any naming definition for branches.
  • Commit your changes.
  • Start a Pull Request.
  • Done πŸ‘ Ask in comments for a review :)
  • 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.
  • You did it πŸŽ‰ We will merge the fix in the master branch.
  • 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.

Add contributor info

πŸ†•πŸ₯ 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

We want to have a CONTRIBUTING.md file in the repo. A good example of such file can be found here. The must must contain the section regarding the "Eclipse Contributor Agreement".

πŸ“‹ 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.

  • Claim this issue: Comment below.
  • Fork the repository in github by simply clicking the 'fork' button.
  • Check out the forked repository
  • Create a feature branch for the issue. We do not have any naming definition for branches.
  • Commit your changes.
  • Start a Pull Request.
  • Done πŸ‘ Ask in comments for a review :)
  • 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.
  • You did it πŸŽ‰ We will merge the fix in the master branch.
  • 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.

Provide Styleguide for Adoptium logo & project logos

πŸ†•πŸ₯ 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

Currently we have 3 different logos: Adoptium, Temurin & AQAvit. The design agency provided a small styleguide. The style guide should be migrated to AsciiDoc.
A styleguide of the Eclipse logo can be found here. That is a good reference about text and infos that should be part of a styleguide.

πŸ“‹ 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.

  • Claim this issue: Comment below.
  • Fork the repository in github by simply clicking the 'fork' button.
  • Check out the forked repository
  • Create a feature branch for the issue. We do not have any naming definition for branches.
  • Commit your changes.
  • Start a Pull Request.
  • Done πŸ‘ Ask in comments for a review :)
  • 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.
  • You did it πŸŽ‰ We will merge the fix in the master branch.
  • 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.

Migrate the "Infrastructure Guide" to the documentation

πŸ†•πŸ₯ 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 infrastructure documentation of Adoptium that can be found at https://github.com/adoptium/infrastructure/blob/master/FAQ.md
It 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.

  • Claim this issue: Comment below.
  • Fork the repository in github by simply clicking the 'fork' button.
  • Check out the forked repository
  • Create a feature branch for the issue. We do not have any naming definition for branches.
  • Commit your changes.
  • Start a Pull Request.
  • Done πŸ‘ Ask in comments for a review :)
  • 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.
  • You did it πŸŽ‰ We will merge the fix in the master branch.
  • 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.

Migrate "Support" documentation to Asciidoc

πŸ†•πŸ₯ 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 information that can be found at https://adoptium.net/support.html must be converted to asciidoc and stored as a document 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.

  • Claim this issue: Comment below.
  • Fork the repository in github by simply clicking the 'fork' button.
  • Check out the forked repository
  • Create a feature branch for the issue. We do not have any naming definition for branches.
  • Commit your changes.
  • Start a Pull Request.
  • Done πŸ‘ Ask in comments for a review :)
  • 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.
  • You did it πŸŽ‰ We will merge the fix in the master branch.
  • 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.

Document support for Icons (FontAwesome)

πŸ†•πŸ₯ 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

It is really helpful to have a set of icons that can be used in documentation. AsciiDoc provides support for icons and this doc already uses some of them. We want to use vector based icons and not image / pixel based icons in our documentations. Therefore the support for font based icons in AsciiDoc sounds like a good idea. This is based on Font Awesome. We should provide a short documentation regarding the usage of such icons in the documentation. Next to this an information of the supported Font Awesome version would be good.

πŸ“‹ 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.

  • Claim this issue: Comment below.
  • Fork the repository in github by simply clicking the 'fork' button.
  • Check out the forked repository
  • Create a feature branch for the issue. We do not have any naming definition for branches.
  • Commit your changes.
  • Start a Pull Request.
  • Done πŸ‘ Ask in comments for a review :)
  • 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.
  • You did it πŸŽ‰ We will merge the fix in the master branch.
  • 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.

Add Code of Conduct

πŸ†•πŸ₯ 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

We want to have information about the "code of conduct" directly in the repo. This is done by providing a CODE_OF_CONDUCTION.md file. Since this is a project under the umbrella of the Eclipse Foundation we can easily link to the "code of conduct" of the foundation as it is done here: https://github.com/adoptium/api.adoptium.net/blob/main/CODE_OF_CONDUCTION.md

πŸ“‹ 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.

  • Claim this issue: Comment below.
  • Fork the repository in github by simply clicking the 'fork' button.
  • Check out the forked repository
  • Create a feature branch for the issue. We do not have any naming definition for branches.
  • Commit your changes.
  • Start a Pull Request.
  • Done πŸ‘ Ask in comments for a review :)
  • 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.
  • You did it πŸŽ‰ We will merge the fix in the master branch.
  • 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.

Documentation for ZenHub

We need a documentation and "getting started" guide regarding our ZenHub board for newcomers.

Find the best way to introduce css stylesheets

πŸ†•πŸ₯ 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 PR #13 introduced custom style classes for the documentation. To support such classes a new css file needs to be added. Asciidoc provides different ways how such CSS file can be loaded. Some documentation can be found here:

https://docs.asciidoctor.org/asciidoc/latest/text/custom-inline-styles/
https://docs.asciidoctor.org/asciidoctor/latest/html-backend/default-stylesheet/#customize-extend
https://docs.asciidoctor.org/asciidoctor/latest/html-backend/custom-stylesheet/

Currently the new style sheet is defined directly on the asciidoc files and internally does an css import to include the original asciidoc stylesheet. We need to check if this is the best way to do it or if we better add such informational parameters to the asciidoctor command (see build.sh file).

As a result this issue should provide a short overview of the different possibilities and their benefits. Based on a simple discussion in this issue a PullRequest with the best possibility should be provided.

πŸ“‹ 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.

  • Claim this issue: Comment below.
  • Fork the repository in github by simply clicking the 'fork' button.
  • Check out the forked repository
  • Create a feature branch for the issue. We do not have any naming definition for branches.
  • Commit your changes.
  • Start a Pull Request.
  • Done πŸ‘ Ask in comments for a review :)
  • 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.
  • You did it πŸŽ‰ We will merge the fix in the master branch.
  • 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.

Introduce CSS to Asciidoctor sources

In this Issue the prior work of PR #13 and issue #16 should be combined.

Description of the issue

In PR #13 @hendrikebbers provides a basic styling for the Adoptium documentation.
These classes have to be applied to all adoc files in the repository.

In issue #16 @hendrikebbers and @MBoegers aggreed on:

Acceptance

  • configure build.sh to use the stylesheets
  • configure GitHub Action build to use the stylesheets

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.

Usage of internal cross references in Asciidoc

πŸ†•πŸ₯ 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

In the migration documentation (https://github.com/AdoptOpenJDK/website-adoptium-documentation/blob/main/migration/index.adoc) several links direct to the migration page of AdoptOpenJDK. Instead of doing so such links should be defined as internal cross references in Asciidoc since all this paragraphs are part of the same documentation file.

πŸ“‹ 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.

  • Claim this issue: Comment below.
  • Fork the repository in github by simply clicking the 'fork' button.
  • Check out the forked repository
  • Create a feature branch for the issue. We do not have any naming definition for branches.
  • Commit your changes.
  • Start a Pull Request.
  • Done πŸ‘ Ask in comments for a review :)
  • 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.
  • You did it πŸŽ‰ We will merge the fix in the master branch.
  • 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.

Community meeting Kickoff

Since some people are interested in working on the Adoptium documentation I plan to create a bi-weekly community meeting to sync between all the awesome volunteers πŸš€

I created a Doodle to find a good day & time. This is not to define a specific date within the next week but to find a general slot that will work for most people. If we can not find a good slot I will add more options to the doodle.

The meetings will be open for all and should be used to present results, sync work and help other volunteers to get into the project. I will create an issue for each meeting that can be used to simple add topics to the agenda and store the minutes of the meeting.

Migrate 'Supported Platforms' to AsciiDoc

πŸ†•πŸ₯ 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 content of the Adoptium 'Supported Platforms' page should be migrated to AsciiDoc.

πŸ“‹ 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.

  • Claim this issue: Comment below.
  • Fork the repository in github by simply clicking the 'fork' button.
  • Check out the forked repository
  • Create a feature branch for the issue. We do not have any naming definition for branches.
  • Commit your changes.
  • Start a Pull Request.
  • Done πŸ‘ Ask in comments for a review :)
  • 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.
  • You did it πŸŽ‰ We will merge the fix in the master branch.
  • 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.

Better documentation of ECA process for newcomer

In the last meeting (#29) @Plexar mentioned that he had some problems setting up the system. I Copied the comment from the meeting minutes:

There are some pitfalls for new developers in this project:

  • when you claimed an issue by commenting, you should start work on the issue after you have been assigned to be properly mentionned as contributor
  • your Eclipse Adoptium email address, your Github email address AND the email address doing a commit with should be equal

Documentation Community Meeting - 25 Oct 2021

This is the agenda and documentation of a community meeting for the Adoptium homepage and documentation. If you plan to attend please leave a comment in this issue :)

πŸ“Œ Date
We will meet on Monday, 25 Oct. 2021 at 16:30 GMT+2 (Germany/Berlin).
For the first meeting I plan to use Google Meet: Link to the meeting

πŸ“„ Agenda

πŸ‘₯ How to attend?
The meeting is open for everyone :) If you want to contribute to the Adoptium documentation or just want to know what we are doing just join the meeting. If possible please add a short comment to this issue that you plan to attend the meeting. This meeting is managed in the Adoptium Community calendar. An ICAL link to integrate the calendar in other tools can be found here. If you plan to attend please leave a comment in this issue :)

πŸŽ‰ Achievements since last meeting

✏️ Minutes

  • https://github.com/Plexar will take care of GitHub Action for repo
  • https://github.com/Plexar contribution is now mentioned
  • "Good First Issue" template -> Some changes are needed. https://github.com/Plexar had some problems to start.
  • "Good First Issue" template should be added to documentation
  • Results like #16 should be created as adoc files in our documentation
  • We will shift the bi-weekly one week. Next meeting will be in 3 weeks.

Provide documentation about css classes & styling

πŸ†•πŸ₯ 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 PR #13 introduced custom style classes for the documentation. We need to provide a documentation of such classes (and some common asciidoc basic classes) that can be used in the documentation.

πŸ“‹ 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.

  • Claim this issue: Comment below.
  • Fork the repository in github by simply clicking the 'fork' button.
  • Check out the forked repository
  • Create a feature branch for the issue. We do not have any naming definition for branches.
  • Commit your changes.
  • Start a Pull Request.
  • Done πŸ‘ Ask in comments for a review :)
  • 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.
  • You did it πŸŽ‰ We will merge the fix in the master branch.
  • 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.

Migrate Adoptium FAQ to Asciidoc

πŸ†•πŸ₯ 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 content of the FAQ page should be migrated to the AsciiDoc based documentation.

πŸ“‹ 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.

  • Claim this issue: Comment below.
  • Fork the repository in github by simply clicking the 'fork' button.
  • Check out the forked repository
  • Create a feature branch for the issue. We do not have any naming definition for branches.
  • Commit your changes.
  • Start a Pull Request.
  • Done πŸ‘ Ask in comments for a review :)
  • 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.
  • You did it πŸŽ‰ We will merge the fix in the master branch.
  • 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.

Documentation Community Meeting - 11 Oct 2021

First meeting of the community πŸŽ‰

πŸ“Œ Date
We will meet on Monday, 11 Oct. 2021 at 16:30 GMT+2 (Germany/Berlin).
For the first meeting I plan to use Google Meet: Link to the meeting

πŸ“Œ Agenda

πŸ“Œ How to attend?
The meeting is open for everyone :) If you want to contribute to the Adoptium documentation or just want to know what we are doing just join the meeting. If possible please add a short comment to this issue that you plan to attend the meeting.

πŸ“Œ Minutes

Documentation Community Meeting - 13 Dec 2021

This is the agenda and documentation of a community meeting for the Adoptium homepage and documentation. If you plan to attend please leave a comment in this issue :)

πŸ“Œ Date

We will meet on Monday, 13 Dec. 2021 at 16:30 GMT+2 (Germany/Berlin).
For the meeting use Google Meet: Link to the meeting

πŸ“„ Agenda

TODO

πŸ‘₯ How to attend?

The meeting is open for everyone :) If you want to contribute to the Adoptium documentation or just want to know what we are doing just join the meeting. If possible please add a short comment to this issue that you plan to attend the meeting. This meeting is managed in the Adoptium Community calendar. An ICAL link to integrate the calendar in other tools can be found here. If you plan to attend please leave a comment in this issue :)

πŸ†•πŸ₯ Newcomer support

We assume that this project is a very good opportunity to start with open source contributions. Therefore we always provide several "good first" issues. More information can be found here.

πŸŽ‰ Achievements since last meeting

TODO

✏️ Minutes

TODO

Documentation Community Meeting - 29 Nov 2021

This is the agenda and documentation of a community meeting for the Adoptium homepage and documentation. If you plan to attend please leave a comment in this issue :)

πŸ“Œ Date

We will meet on Monday, 29 Nov. 2021 at 16:30 GMT+2 (Germany/Berlin).
For the meeting use Google Meet: Link to the meeting

πŸ“„ Agenda

πŸ‘₯ How to attend?

The meeting is open for everyone :) If you want to contribute to the Adoptium documentation or just want to know what we are doing just join the meeting. If possible please add a short comment to this issue that you plan to attend the meeting. This meeting is managed in the Adoptium Community calendar. An ICAL link to integrate the calendar in other tools can be found here. If you plan to attend please leave a comment in this issue :)

πŸ†•πŸ₯ Newcomer support

We assume that this project is a very good opportunity to start with open source contributions. Therefore we always provide several "good first" issues. More information can be found here.

πŸŽ‰ Achievements since last meeting

✏️ Minutes

  • We will plan bi-weekly pair programming sessions
  • Milestone 1 will be reached with the merge of adoptium/documentation-services#42
  • Milestone 2 will be a hosted service that is ready for integration in adoptium.net
  • Code formating, Coding rules & test workflows: We will add some definitions to contibutions.md (links), we like hoe we currently work and will continue

Define needed attributes for Asciidoc documents

πŸ†•πŸ₯ 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

Asciidoc supports attributes in documents. A document can contain predefined attributes or custom attributes.

We should define a list of attributes that should be specified in the document headers. A good starting point is the document metadata like the description that is be used to automatically generate HTML metadata. Next to the header attributes there will be some attributes that are the same for all documents (like copyright or orgname). Such attributes must be defined too since they will be set when rendering the documents.

πŸ“‹ 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.

  • Claim this issue: Comment below.
  • Fork the repository in github by simply clicking the 'fork' button.
  • Check out the forked repository
  • Create a feature branch for the issue. We do not have any naming definition for branches.
  • Commit your changes.
  • Start a Pull Request.
  • Done πŸ‘ Ask in comments for a review :)
  • 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.
  • You did it πŸŽ‰ We will merge the fix in the master branch.
  • 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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.