Merge pull request #2853 from SueChaplain/movebuilddoc

Move build instructions to the /doc directory
eclipse-openj9 · Sep 13, 2018 · 59cccae · 59cccae
2 parents 7295071 + f69c15c
commit 59cccae
Show file tree

Hide file tree

Showing 10 changed files with 1,850 additions and 1,759 deletions.
diff --git a/buildenv/Build_Instructions_V10.md b/buildenv/Build_Instructions_V10.md
diff --git a/buildenv/Build_Instructions_V11.md b/buildenv/Build_Instructions_V11.md
diff --git a/buildenv/Build_Instructions_V8.md b/buildenv/Build_Instructions_V8.md
diff --git a/buildenv/Build_Instructions_V9.md b/buildenv/Build_Instructions_V9.md
diff --git a/doc/README.md b/doc/README.md
@@ -26,15 +26,14 @@ Documentation
 
 This directory contains the following types of documentation:
 
-* **`processes`**: Documentation about the processes used in OpenJ9.
+| Directory            |    Contents                                                                  |
+|----------------------|------------------------------------------------------------------------------|
+| `build-instructions` | Build instructions for compiling OpenJDK with OpenJ9.                        |
+| `compiler`           | Developer documentation about the compiler technology, codenamed Testarossa. |
+| `diagnostics`        | Developer documentation about the diagnostic component of OpenJ9.            |
+| `processes`          | Process documentation for the OpenJ9 project.                                |
+| `release-notes`      | OpenJ9 release notes.                                                        |
 
-* **`release-notes`**: Release notes for different releases of OpenJ9.
+:pencil: Developer documentation about OpenJ9 technology or components is best considered in tandem with the [documentation from Eclipse OMR](https://github.com/eclipse/omr/tree/master/doc), as OpenJ9 is built upon the foundational technologies provided by OMR.
 
-* **`compiler`**: Documentation about the compiler technology, codenamed
-  Testarossa.
-
-* **`diagnostics`**: Documentation about the diagnostic component of OpenJ9.
-
-Documentation about OpenJ9 technology or components is best considered in tandem with the
-[documentation from Eclipse OMR](https://github.com/eclipse/omr/tree/master/doc),
-as OpenJ9 is built upon the foundational technologies provided by OMR.
+:pencil: User documentation for OpenJ9 is published at the [OpenJ9 website](https://www.eclipse.org/openj9/docs/)
diff --git a/doc/build-instructions/Build_Instructions_V10.md b/doc/build-instructions/Build_Instructions_V10.md
diff --git a/doc/build-instructions/Build_Instructions_V11.md b/doc/build-instructions/Build_Instructions_V11.md
diff --git a/doc/build-instructions/Build_Instructions_V8.md b/doc/build-instructions/Build_Instructions_V8.md
diff --git a/doc/build-instructions/Build_Instructions_V9.md b/doc/build-instructions/Build_Instructions_V9.md
diff --git a/doc/cmake.md → doc/build-instructions/cmake.md b/doc/cmake.md → doc/build-instructions/cmake.md
@@ -10,7 +10,7 @@ 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 
+General Public License, version 2 with the GNU Classpath
 Exception [1] and GNU General Public License, version 2 with the
 OpenJDK Assembly Exception [2].
 
@@ -22,7 +22,7 @@ SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0 WITH Classpath-excepti
 
 # CMake Getting Started / FAQ
 
-Note: the information here is meant to supplement the
+:pencil: the information here is meant to supplement the
 [OMR CMake documentation](https://github.com/eclipse/omr/blob/master/doc/BuildingWithCMake.md).
 
 ## FAQ
@@ -31,8 +31,8 @@ Note: the information here is meant to supplement the
 Generally only shared libraries / executables are installed. Static libraries are
 not since they are considered temporary artifacts generated by the build.
 
-*Note:* Here `install()` insn't being used in its normal sense. Here it's used
+:pencil: Here `install()` isn't being used in its normal sense. Here it's used
 just to update the `rpath` (on applicable platforms) and to move the binary
 to the corresponding source directory. We do this purely for compatability with
-existing build infrastructure which expects the binaries to be layed out as they
+existing build infrastructure that expects the binaries to be laid out as they
 would be under a `makefile` driven build.