# openj9-docs

**Repository Path**: mirrors_eclipse/openj9-docs

## Basic Information

- **Project Name**: openj9-docs
- **Description**: Source repository for the Eclipse OpenJ9 user documentation, which should be viewed [online]https://www.eclipse.org/openj9/docs/
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-22
- **Last Updated**: 2026-08-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<!--
* Copyright (c) 2017, 2026 IBM Corp. and others
*
* This program and the accompanying materials are made
* available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution and is available at
* https://www.eclipse.org/legal/epl-2.0/ or the Apache
* License, Version 2.0 which accompanies this distribution and
* is available at https://www.apache.org/licenses/LICENSE-2.0.
*
* This Source Code may also be made available under the
* following Secondary Licenses when the conditions for such
* availability set forth in the Eclipse Public License, v. 2.0
* are satisfied: GNU General Public License, version 2 with
* the GNU Classpath Exception [1] and GNU General Public
* License, version 2 with the OpenJDK Assembly Exception [2].
*
* [1] https://www.gnu.org/software/classpath/license.html
* [2] https://openjdk.org/legal/assembly-exception.html
*
* SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0 OR GPL-2.0-only WITH OpenJDK-assembly-exception-1.0
-->

<p align="center">
<img src="https://github.com/eclipse-openj9/openj9/blob/master/artwork/OpenJ9.svg" alt="OpenJ9 logo" align="middle" width="50%" height="50%" />
<p>

# Eclipse OpenJ9 user documentation

[![Build Status](https://openj9-jenkins.osuosl.org/buildStatus/icon?job=Build-Doc-Push_to_Eclipse)](https://openj9-jenkins.osuosl.org/job/Build-Doc-Push_to_Eclipse)

[![License](https://img.shields.io/badge/License-EPL%202.0-green.svg)](https://opensource.org/licenses/EPL-2.0)
[![License](https://img.shields.io/badge/License-APL%202.0-green.svg)](https://opensource.org/licenses/Apache-2.0)

This repository contains the source files for the [Eclipse OpenJ9 user documentation](http://eclipse.dev/openj9/docs).
The user documentation tells you how to configure, tune, and diagnose problems with
an OpenJDK that has been built with the OpenJ9 Java virtual machine.

New to Eclipse OpenJ9? Here are a few links to get you started:

- Visit the [Eclipse OpenJ9 website](http://eclipse.dev/openj9) to find out more.
- Read the [Getting started](https://eclipse.dev/openj9/docs/introduction/) topic in our user documentation.

The files in this repository are authored in markdown format and built using
[Mkdocs](http://www.mkdocs.org/) with the [MkDocs-material theme](https://squidfunk.github.io/mkdocs-material/). Draft documentation for the next release is hosted via the gh-pages branch of this repository at the following URL: https://eclipse-openj9.github.io/openj9-docs/).

We welcome contributions to the user documentation. Please follow our
[Contribution guidelines](CONTRIBUTING.md).