Structural and editorial changes for the website

- Rename menu headers so that they relate better to content - Re-organise some content between topics (building/configuring) - Replace references to JIT with "Compiler" - Indicate that the compiler is now available - Added some blog posts - Updated the presentations page (re-order and more content) - Remove Releases menu item and underlying directory and files Issue: #4 Signed-off-by: Sue Chaplain <sue_chaplain@uk.ibm.com>
eclipse · Dec 22, 2016 · 29aa8d4 · 29aa8d4
1 parent 5e3fabf
commit 29aa8d4
Show file tree

Hide file tree

Showing 11 changed files with 55 additions and 113 deletions.
diff --git a/_includes/header/header-en.html b/_includes/header/header-en.html
@@ -9,7 +9,7 @@
           <li><a href="{{ site.baseurl }}/" id="home-menu"{% if page.menu == 'home' %} class="active"{% endif %}>Home</a></li>
           <li>
               <ul id="getting-started-menu" class="menu">
-                  <li><a href="{{ site.baseurl }}/starter/whatisomr.html"{% if page.menu == 'starter' %} class="active"{% endif %}>Getting started</a>
+                  <li><a href="{{ site.baseurl }}/starter/whatisomr.html"{% if page.menu == 'starter' %} class="active"{% endif %}>About</a>
                       <ul>
                           <li>
                             <a href="{{ site.baseurl }}/starter/whatisomr.html">What is OMR?</a>
@@ -26,7 +26,7 @@
           </li>
           <li>
               <ul id="guide-menu" class="menu">
-                  <li><a href="{{ site.baseurl }}/guide/building.html"{% if page.menu == 'guide' %} class="active"{% endif %}>Guide</a>
+                  <li><a href="{{ site.baseurl }}/guide/building.html"{% if page.menu == 'guide' %} class="active"{% endif %}>Getting started</a>
                       <ul>
                           <li><a href="{{ site.baseurl }}/guide/building.html">Building</a>
                           </li>
@@ -58,7 +58,7 @@
                           </li>
 						  <li><a class="subsub" href="{{ site.baseurl }}/reference/vm.html">VM</a>
                           </li>
-                          <li><a class="subsub" href="{{ site.baseurl }}/reference/jit.html">JIT</a>
+                          <li><a class="subsub" href="{{ site.baseurl }}/reference/jit.html">Compiler</a>
                           </li>
 						  <li><a class="subsub" href="{{ site.baseurl }}/reference/port.html">Port</a>
                           </li>
@@ -80,21 +80,13 @@
                           </li>
                           <li><a href="{{ site.baseurl }}/resources/presentations.html">Presentations</a>
                           </li>
-                          <li><a href="{{ site.baseurl }}/resources/blogs.html">Blogs</a>
+                          <li><a href="{{ site.baseurl }}/resources/blogs.html">Blog posts</a>
                           </li>
                       </ul>
                   </li>
               </ul>
           </li>
 		  <li>
-              <ul id="releases-menu" class="menu">
-                  <li><a href="{{ site.baseurl }}/releases/first-release.html"{% if page.menu == 'releases' %} class="active"{% endif %}>Releases</a>
-                      <ul>
-                          <li><a href="{{ site.baseurl }}/releases/first-release.html">What's new</a>
-                          </li>
-                      </ul>
-                  </li>
-              </ul>
           </li>
       </ul>
 		<div id="eggContainer">

diff --git a/_layouts/header/header-en.html b/_layouts/header/header-en.html
@@ -9,7 +9,7 @@
           <li><a href="{{ site.baseurl }}/" id="home-menu"{% if page.menu == 'home' %} class="active"{% endif %}>Home</a></li>
           <li>
               <ul id="getting-started-menu" class="menu">
-                  <li><a href="{{ site.baseurl }}/starter/whatisomr.html"{% if page.menu == 'starter' %} class="active"{% endif %}>Getting started</a>
+                  <li><a href="{{ site.baseurl }}/starter/whatisomr.html"{% if page.menu == 'starter' %} class="active"{% endif %}>About</a>
                       <ul>
                           <li>
                             <a href="{{ site.baseurl }}/starter/whatisomr.html">What is OMR?</a>
@@ -26,7 +26,7 @@
           </li>
           <li>
               <ul id="guide-menu" class="menu">
-                  <li><a href="{{ site.baseurl }}/guide/building.html"{% if page.menu == 'guide' %} class="active"{% endif %}>Guide</a>
+                  <li><a href="{{ site.baseurl }}/guide/building.html"{% if page.menu == 'guide' %} class="active"{% endif %}>Getting started</a>
                       <ul>
                           <li><a href="{{ site.baseurl }}/guide/building.html">Building</a>
                           </li>
@@ -68,21 +68,13 @@
                           </li>
                           <li><a href="{{ site.baseurl }}/resources/whitepapers.html">Whitepapers</a>
                           </li>
-                          <li><a href="{{ site.baseurl }}/resources/blogs.html">Blogs</a>
+                          <li><a href="{{ site.baseurl }}/resources/blogs.html">Blog posts</a>
                           </li>
                       </ul>
                   </li>
               </ul>
           </li>
 		  <li>
-              <ul id="releases-menu" class="menu">
-                  <li><a href="{{ site.baseurl }}/releases/first-release.html"{% if page.menu == 'releases' %} class="active"{% endif %}>Releases</a>
-                      <ul>
-                          <li><a href="{{ site.baseurl }}/releases/first-release.html">What's new</a>
-                          </li>
-                      </ul>
-                  </li>
-              </ul>
           </li>
       </ul>
   </div>

diff --git a/guide/building.md b/guide/building.md
@@ -45,25 +45,3 @@ Run the following command for a list of configure makefile targets:
 Run the following command for a list of build targets:
 
     make help
-
-### How to configure Eclipse OMR with custom options
-
-Run the following command to see the full list of command-line options (see [Configuring](configuring.html) for full details of all the options):
-
-    ./configure --help
-
-The minimum invocation of `configure` is as follows:
-
-    $ ./configure OMRGLUE=./example/glue`
-
-To run `configure` using both SPEC presets and custom options, add the `EXTRA_CONFIGURE_ARGS` option to `run_configure.mk`.
-
-Example: to disable optimizations, run `configure` like this:
-
-    make -f run_configure.mk SPEC=linux_x86-64 OMRGLUE=./example/glue 'EXTRA_CONFIGURE_ARGS=--disable-optimized' clean all
-
-Example: to disable building FV tests, run `configure` like this:
-
-    make -f run_configure.mk SPEC=linux_x86-64 OMRGLUE=./example/glue 'EXTRA_CONFIGURE_ARGS=--disable-fvtest' clean all
-
-Note that the `clean` target of `run_configure.mk` deletes the header files and makefiles generated by `configure`. Invoking the `clean all` targets ensures that the header files and makefiles are regenerated using the custom options.
diff --git a/guide/configuring.md b/guide/configuring.md
@@ -25,6 +25,27 @@ lang: en
 
 # Configuring OMR
 
-Content is needed for this section of the documentation.
+### How to configure Eclipse OMR with custom options
 
-Pull requests are very welcome if you would like to help. For more information about contributing, see: [https://github.com/eclipse/omr/issues/165](https://github.com/eclipse/omr/issues/165). 
+Run the following command to see the full list of command-line options:
+
+    ./configure --help
+
+The minimum invocation of `configure` is as follows:
+
+    $ ./configure OMRGLUE=./example/glue`
+
+To run `configure` using both SPEC presets and custom options, add the `EXTRA_CONFIGURE_ARGS` option to `run_configure.mk`.
+
+Example: to disable optimizations, run `configure` like this:
+
+    make -f run_configure.mk SPEC=linux_x86-64 OMRGLUE=./example/glue 'EXTRA_CONFIGURE_ARGS=--disable-optimized' clean all
+
+Example: to disable building FV tests, run `configure` like this:
+
+    make -f run_configure.mk SPEC=linux_x86-64 OMRGLUE=./example/glue 'EXTRA_CONFIGURE_ARGS=--disable-fvtest' clean all
+
+Note that the `clean` target of `run_configure.mk` deletes the header files and makefiles generated by `configure`. Invoking the `clean all` targets ensures that the header files and makefiles are regenerated using the custom options.
+
+
+Pull requests are very welcome if you would like to help. For more information about contributing, see: [https://github.com/eclipse/omr/issues/165](https://github.com/eclipse/omr/issues/165).
diff --git a/reference/components.md b/reference/components.md
@@ -23,16 +23,16 @@ lang: en
 [//]: # "*    <First author> - initial implementation and documentation"
 [//]: # "*********************************************************************"
 
-# Components 
+# Components
 
-Eclipse OMR is made up of shared, reusable, open-source core components for building language runtimes. These components include: 
+Eclipse OMR is made up of shared, reusable, open-source core components for building language runtimes. These components include:
 
-- **Garbage Collector (GC):** a garbage collection framework for managed heaps. Eclipse OMR includes several implementations: mark-and-sweep, generational, and parallel scavenger. 
+- **Garbage Collector (GC):** a garbage collection framework for managed heaps. Eclipse OMR includes several implementations: mark-and-sweep, generational, and parallel scavenger.
 - **Port Library (port):** a platform abstraction (porting) library.
 - **Thread Library (thread):** a cross platform threading library.
 - **Utility Library (util):** a variety of utility libraries that provide functions for building cross platform runtimes.
 - **Virtual Machine (VM):** APIs to manage per-interpreter and per-thread contexts.
 - **Trace Library (omrtrace):** a tracing library for communication with IBM Health Center monitoring tools.
 - **Signal Handling Compatibility Library (omrsigcompat):** a signal handling compatibility library.
-- **Just-in-Time (JIT) Compiler:** _(to be contributed)_ native code generation.
-- **Diagnostic services:** _(to be contributed)_ Health Center provides a live view of runtime details, such as GC statistics and method profiling.
+- **Compiler:** for native code generation.
+- **Diagnostic services:** _(to be contributed)_ Health Center provides a live view of runtime details, such as GC statistics and method profiling.
diff --git a/reference/jit.md b/reference/jit.md
@@ -1,6 +1,6 @@
 ---
 layout: page
-title: JIT
+title: Compiler
 menu: reference
 lang: en
 ---
@@ -23,8 +23,8 @@ lang: en
 [//]: # "*    <First author> - initial implementation and documentation"
 [//]: # "*********************************************************************"
 
-# JIT
+# Compiler
 
 Content is needed for this section of the documentation.
 
-Pull requests are very welcome if you would like to help. For more information about contributing, see: [https://github.com/eclipse/omr/issues/165](https://github.com/eclipse/omr/issues/165). 
+Pull requests are very welcome if you would like to help. For more information about contributing, see: [https://github.com/eclipse/omr/issues/165](https://github.com/eclipse/omr/issues/165).
diff --git a/reference/port.md b/reference/port.md
@@ -30,7 +30,7 @@ services, excluding those handled by the Thread Library.
 
 The Port Library is designed to be a standalone component that can be used to
 add multiplatform support to many projects. Thus Port Library APIs must not
-have dependencies on other OMR components, such as GC or JIT. They can use
+have dependencies on other OMR components, such as the Garbage Collector (GC) or Compiler. They can use
 omrthread_ APIs.
 
 In addition to abstracting platform-dependent details, Port Library APIs also
@@ -46,6 +46,3 @@ For example:
 
     OMRPORT_ACCESS_FROM_OMRVMTHREAD(omrVmThread);
     void *buffer = omrmem_allocate_memory(1024, OMRMEM_CATEGORY_MM);
-
-
-
diff --git a/releases/first-release.md b/releases/first-release.md
diff --git a/resources/blogs.md b/resources/blogs.md
@@ -1,6 +1,6 @@
 ---
 layout: page
-title: Blogs
+title: Blog posts
 menu: resources
 lang: en
 ---
@@ -23,8 +23,8 @@ lang: en
 [//]: # "*    <First author> - initial implementation and documentation"
 [//]: # "*********************************************************************"
 
-# Blogs
+# Blog posts
 
-Content is needed for this section of the documentation.
-
-Pull requests are very welcome if you would like to help. For more information about contributing, see: [https://github.com/eclipse/omr/issues/165](https://github.com/eclipse/omr/issues/165). 
+- [Introducing the Ruby+OMR JIT](https://developer.ibm.com/open/2016/11/18/introducing-ruby-jit/) by Matthew Gaudet, November 18, 2016
+- [JitBuilder Library and Eclipse OMR: Just-in-time compilers made easy](https://developer.ibm.com/open/2016/07/19/jitbuilder-library-and-eclipse-omr-just-in-time-compilers-made-easy/) by Mark Stoodley, July 19, 2016
+- [Introducing Eclipse OMR: Building language runtimes](https://developer.ibm.com/open/2016/03/08/introducing-omr-building-language-runtimes/) by Mark Stoodley, March 8, 2016
diff --git a/resources/presentations.md b/resources/presentations.md
@@ -23,23 +23,16 @@ lang: en
 [//]: # "*    <First author> - initial implementation and documentation"
 [//]: # "*********************************************************************"
 
-# Recent Presentations about Eclipse OMR:
+# Recent presentations
 
-- Mark Stoodley, [*A VM is a VM is a VM: The Secret Path to High Performance Multi-Language Runtimes.*](https://www.youtube.com/watch?v=kOnyJurioyw)  Talk at the JVM Languages Summit, August 2015.
+- [*Eclipse OMR Tech Talk.*](https://developer.ibm.com/open/videos/eclipse-omr-tech-talk/) Mark Stoodley, developerWorks Open, July 2016.
+- [*OMR: A modern toolkit for building language runtimes*](http://www.slideshare.net/MarkStoodley/omr-a-modern-toolkit-for-building-language-runtimes). Mark Stoodley, EclipseCON, March 2016.
+- [*A JVMs Journey into Polyglot Runtimes.*](https://t.co/efCKf6aCB4) Charlie Gracie, jFokus, February 2016.
+- [*Ruby and OMR: Experiments in utilizing OMR technologies in MRI.*](http://bofh.nikhef.nl/events/FOSDEM/2016/h2213/ruby-and-omr.mp4) Charlie Gracie, FOSDEM, February 2016.
+- [*Building Your Own Runtime.*](https://ibm.box.com/s/7xdg25we2ezmdjjbqdys30d7dl1iyo49) Angela Lin, Robert Young, Craig Lehmann, and Xiaoli Liang, CASCON Workshop, November 2015.
+- [*What's in an Object? Java Garbage Collection for the Polyglot.*](http://www.slideshare.net/charliegracie1/javaone-whats-in-an-object) Charlie Gracie, Java One, October 2015.
+- [*Beyond the Coffee Cup: Leveraging Java Runtime Technologies for the Polyglot.*](http://www.slideshare.net/0xdaryl/javaone-2015-con7547-beyond-the-coffee-cup-leveraging-java-runtime-technologies-for-polyglot?related=1) Daryl Maier, Java One, October 2015.
+- [*A VM is a VM is a VM: The Secret Path to High Performance Multi-Language Runtimes.*](https://www.youtube.com/watch?v=kOnyJurioyw) Mark Stoodley, JVM Languages Summit, August 2015.
 
-- Daryl Maier, [*Beyond the Coffee Cup: Leveraging Java Runtime Technologies for the Polyglot.*](http://www.slideshare.net/0xdaryl/javaone-2015-con7547-beyond-the-coffee-cup-leveraging-java-runtime-technologies-for-polyglot?related=1) Slides from Java One, October 2015.
-
-- Charlie Gracie, [*What's in an Object? Java Garbage Collection for the Polyglot.*](http://www.slideshare.net/charliegracie1/javaone-whats-in-an-object) Slides from Java One, October 2015.
-
-- Angela Lin, Robert Young, Craig Lehmann, and Xiaoli Liang, [*Building Your Own Runtime.*](https://ibm.box.com/s/7xdg25we2ezmdjjbqdys30d7dl1iyo49) CASCON Workshop, November 2015.
-
-- Mark Stoodley, [*Eclipse OMR Tech Talk.*](https://developer.ibm.com/open/videos/eclipse-omr-tech-talk/) developerWorks Open, July 2016.
-
-Note: the following slides have been modified since the original presentation to include the Eclipse OMR project name.
-
-- Charlie Gracie, [*Ruby and OMR: Experiments in utilizing OMR technologies in MRI.*](http://bofh.nikhef.nl/events/FOSDEM/2016/h2213/ruby-and-omr.mp4) Talk from FOSDEM, February 2016.
-
-- Charlie Gracie, [*A JVMs Journey into Polyglot Runtimes.*](https://t.co/efCKf6aCB4) Slides from jFokus, February 2016.
-
-- Mark Stoodley, *OMR: A modern toolkit for building language runtimes* (link when available). Slides from EclipseCON, March 2016.
 
+Note: Some slides have been modified since the original presentation to include the Eclipse OMR project name.
diff --git a/starter/goals.md b/starter/goals.md
@@ -36,6 +36,5 @@ There are some **active contribution projects** underway right now:
 - **starters:** relatively simple but useful work items meant for people new to the project
 - **diag:** more diagnostic support for language runtimes to help developers and users
 - **hcagent:** the core code for the IBM Health Center agent for interfacing to a runtime
-- **jit:** Just In Time compiler for generating native code for several platforms into managed code caches
+- **jit:** Compiler for generating native code for several platforms into managed code caches
 - **gc:** adding generational and other GC policies
-