Add Harmonic 🎵

.github/labeler.yml

@@ -16,3 +16,6 @@
 🌱 garden:
   - garden/*
   - garden/**/*
+🎵 harmonic:
+  - harmonic/*
+  - harmonic/**/*

garden/install_osx_src.md

@@ -88,11 +88,13 @@ brew cask install xquartz
 General dependencies:
 
 ```bash
-brew install assimp boost bullet cmake cppzmq dartsim@6.10.0 doxygen eigen fcl ffmpeg flann freeimage freetype gflags google-benchmark gts ipopt irrlicht jsoncpp libccd libyaml libzzip libzip nlopt ode open-scene-graph ossp-uuid ogre1.9 ogre2.2 pkg-config protobuf qt qwt rapidjson ruby tbb tinyxml tinyxml2 urdfdom zeromq
+brew install assimp boost bullet cmake cppzmq dartsim@6.10.0 doxygen eigen fcl ffmpeg flann freeimage freetype gflags google-benchmark gts ipopt irrlicht jsoncpp libccd libyaml libzzip libzip nlopt ode open-scene-graph ossp-uuid ogre1.9 ogre2.3 pkg-config protobuf qt qwt rapidjson ruby tbb tinyxml tinyxml2 urdfdom zeromq
 ```
 
 `dartsim@6.10.0` and `qt5` are not sym-linked. To use those dependencies when building
-`gazebo-physics2` and `gazebo-gui3`, run the following after installation to add them to `/use/local`:
+`gz-physics6` and `gz-gui7`, run the following after installation:
+
+For Macs with Intel processors, add them to `/usr/local`:
 
 ```bash
 # dartsim@6.10.0
@@ -103,6 +105,17 @@ export PKG_CONFIG_PATH=${PKG_CONFIG_PATH}:/usr/local/opt/dartsim@6.10.0/lib/pkgc
 export CMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH}:/usr/local/opt/qt@5
 ```
 
+Note if you are on an ARM based Apple Silicon Mac machine, you will need to add them to /opt/homebrew instead:
+
+```bash
+# dartsim@6.10.0
+export CMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH}:/opt/homebrew/opt/dartsim@6.10.0
+export DYLD_FALLBACK_LIBRARY_PATH=${DYLD_FALLBACK_LIBRARY_PATH}:/opt/homoebrew/opt/dartsim@6.10.0/lib:/opt/homebrew/opt/octomap/local
+export PKG_CONFIG_PATH=${PKG_CONFIG_PATH}:/opt/homebrew/opt/dartsim@6.10.0/lib/pkgconfig
+# qt5
+export CMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH}:/opt/homebrew/opt/qt@5
+```
+
 ### Install compiler requirements
 
 The Gazebo Libraries require the Xcode 10 compiler on MacOS Mojave.

garden/install_ubuntu_src.md

@@ -172,7 +172,7 @@ colcon build --packages-select PACKAGE_NAME
 
 Visit [colcon documentation](https://colcon.readthedocs.io/en/released/#) to view more `colcon` build and test options.
 
-If there are no errors, all the binaries should be ready to use. You can check the [Troubleshooting] section for errors.
+If there are no errors, all the binaries should be ready to use. You can check the [Troubleshooting](/docs/garden/troubleshooting#ubuntu) section for errors.
 
 ## Using the workspace
 

garden/troubleshooting.md

@@ -5,13 +5,17 @@ If you see this error message:
 
 ```bash
 I cannot find any available 'gz' command:
-	* Did you install any gazebo library?
+	* Did you install any Gazebo library?
 	* Did you set the GZ_CONFIG_PATH environment variable?
-	    E.g.: export GZ_CONFIG_PATH=$HOME/local/share/gazebo
+	    E.g.: export GZ_CONFIG_PATH=$HOME/local/share/gz
 ```
 
-You should set up the environment variable `GZ_CONFIG_PATH=/usr/local/share/gazebo/`
+You should set up the environment variable:
 
+```
+# replace <path_to_install_dir> to your Gazebo installation directory
+GZ_CONFIG_PATH=<path_to_install_dir>/share/gz/
+```
 
 ## macOS
 
@@ -143,10 +147,10 @@ As suggested on the Ogre logs, this may require updating your graphics card
 drivers.
 
 The Ogre 2 debs from the osrfoundation repository are built from a fork of
-Ogre's `v2-1` branch with changes needed for deb packaging and allowing it to
+Ogre's `v2-3` branch with changes needed for deb packaging and allowing it to
 be co-installable with Ogre 1.x. The code can be found here:
 
-https://github.com/gazebo-forks/ogre-2.1-release
+https://github.com/gazebo-forks/ogre-2.3-release
 
 
 ## Windows

harmonic/index.yaml

@@ -0,0 +1,34 @@
+# This file is an index of the pages to display on the documentation website
+# (https://gazebosim.org/docs). The order of the pages in this file
+# is reflected on the website's left sidebar.
+#
+# Components of the index:
+#
+# 1. "pages:" The master list of pages
+#
+# 2. Each page has a
+#    a. "name:" This should be a short url-friendly and unique name. It will
+#    be used in the website url.
+#
+#    b. "title:" This is a human-friendly title for the page. This title will
+#    be displayed on the website's left side bar.
+#
+#    c. "file:" The markdown file that contains the page's content.
+pages:
+  - name: install
+    title: Install
+    file: install.md
+    description: Harmonic installation instructions
+    children:
+      - name: install_ubuntu_src
+        title: Ubuntu Source Install
+        file: install_ubuntu_src.md
+      - name: install_osx_src
+        title: macOS Source Install
+        file: install_osx_src.md
+      - name: install_windows_src
+        title: Windows Source Install
+        file: install_windows_src.md
+      - name: troubleshooting
+        title: Troubleshooting
+        file: troubleshooting.md

harmonic/install.md

@@ -0,0 +1,59 @@
+# Gazebo Harmonic
+
+Up to Harmonic's release date, the collection should be considered unstable.
+
+Gazebo Harmonic will be the 8th major release of Gazebo. It will be a
+long-term release.
+
+## Binary installation instructions
+
+There are no Harmonic binaries at the moment
+
+## Source Installation instructions
+
+Source installation is recommended for users planning on altering Gazebo's source code (advanced).
+
+ * [Source Installation on Ubuntu](install_ubuntu_src)
+ * [Source Installation on macOS](install_osx_src)
+ * [Source Installation on Windows](install_windows_src)
+
+## Harmonic Libraries
+
+The Harmonic collection is composed of many different Gazebo libraries. The
+collection assures that all libraries are compatible and can be used together.
+
+This list of library versions may change up to the release date.
+
+| Library name       | Version       |
+| ------------------ |:-------------:|
+|   gz-cmake         |       3.x     |
+|   gz-common        |       5.x     |
+|   gz-fuel-tools    |       8.x     |
+|   gz-sim           |       8.x     |
+|   gz-gui           |       8.x     |
+|   gz-launch        |       7.x     |
+|   gz-math          |       7.x     |
+|   gz-msgs          |       9.x     |
+|   gz-physics       |       6.x     |
+|   gz-plugin        |       2.x     |
+|   gz-rendering     |       8.x     |
+|   gz-sensors       |       8.x     |
+|   gz-tools         |       2.x     |
+|   gz-transport     |      12.x     |
+|   gz-utils         |       2.x     |
+|   sdformat         |      13.x     |
+
+## Supported platforms
+
+Harmonic is planned to be [supported](/docs/all/releases) on the platforms below.
+This list may change up to the release date.
+
+These are the **officially** supported platforms:
+
+* Ubuntu Focal on amd64
+* Ubuntu Jammy on amd64
+
+Platforms supported at **best-effort** include arm architectures, Windows and
+macOS. See
+[this ticket](https://github.com/gazebo-tooling/release-tools/issues/597)
+for the full status.