Fortress (#174)

Signed-off-by: Louise Poubel <[email protected]>

Co-authored-by: Ashton Larkin <[email protected]>

.github/labeler.yml

@@ -10,3 +10,6 @@
 🏢 edifice:
   - edifice/*
   - edifice/**/*
+🏯 fortress:
+  - fortress/*
+  - fortress/**/*

edifice/install.md

@@ -39,7 +39,7 @@ collection assures that all libraries are compatible and can be used together.
 | ------------------ |:-------------:|
 |   ign-cmake        |       2.x     |
 |   ign-common       |       4.x     |
-|   ign-fuel_tools   |       6.x     |
+|   ign-fuel-tools   |       6.x     |
 |   ign-gazebo       |       5.x     |
 |   ign-gui          |       5.x     |
 |   ign-launch       |       4.x     |

fortress/index.yaml

@@ -0,0 +1,43 @@
+# This file is an index of the pages to display on the documentation website
+# (https://ignitionrobotics.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: Fortress installation instructions
+    children:
+      - name: install_ubuntu
+        title: Binary Ubuntu Install
+        file: install_ubuntu.md
+      - name: install_osx
+        title: Binary macOS Install
+        file: install_osx.md
+      - name: install_windows
+        title: Binary Windows Install
+        file: install_windows.md
+      - 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

fortress/install.md

@@ -0,0 +1,57 @@
+# Fortress Installation
+
+Until the official release, Fortress can be compiled from source or installed
+from nightly debian packages on Linux.
+
+Fortress supports the following platforms:
+
+ * Ubuntu Bionic amd64 and Focal on amd64
+ * MacOS Mojave and Catalina
+     * Ignition currently only works in headless mode
+      (GUI does not render; instead of using `ign gazebo fuel.sdf` command, use
+      `ign gazebo -s fuel.sdf` to start the server only).
+ * Windows 10
+     * Ignition command line utilities are not yet supported.
+     * All packages up to `ign-gazebo` can be built.
+     * DART physics engine is not yet supported.
+     * Qt (GUI functionality) is not yet supported.
+
+## Binary installation instructions
+
+Binary installation is the recommended method of installing Ignition.
+
+ * [Binary Installation on Ubuntu](install_ubuntu)
+ * [Binary Installation on macOS](install_osx)
+ * [Binary Installation on Windows](install_windows)
+
+## Source Installation instructions
+
+Source installation is recommended for users planning on altering Ignition'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)
+
+## Fortress Libraries
+
+The Fortress collection is composed of many different Ignition libraries. The
+collection assures that all libraries are compatible and can be used together.
+
+| Library name       | Version       |
+| ------------------ |:-------------:|
+|   ign-cmake        |       2.x     |
+|   ign-common       |       4.x     |
+|   ign-fuel-tools   |       7.x     |
+|   ign-gazebo       |       6.x     |
+|   ign-gui          |       6.x     |
+|   ign-launch       |       5.x     |
+|   ign-math         |       6.x     |
+|   ign-msgs         |       8.x     |
+|   ign-physics      |       5.x     |
+|   ign-plugin       |       1.x     |
+|   ign-rendering    |       6.x     |
+|   ign-sensors      |       6.x     |
+|   ign-tools        |       1.x     |
+|   ign-transport    |      11.x     |
+|   ign-utils        |       1.x     |
+|   sdformat         |      12.x     |

fortress/install_osx.md

@@ -0,0 +1,37 @@
+# Binary Installation on MacOS
+
+All the Fortress binaries are available in Mojave and Catalina using the
+[homebrew package manager](https://brew.sh/).
+
+Up to Fortress's release date, the binaries should be considered unstable.
+
+The homebrew tool can be installed using:
+
+```bash
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
+```
+
+After installing the homebrew package manager, Ignition Fortress can be installed running:
+
+```bash
+brew tap osrf/simulation
+brew install ignition-fortress
+```
+
+All libraries should be ready to use and the `ign gazebo` app ready to be executed.
+
+Head back to the [Getting started](/docs/all/getstarted)
+page to start using Ignition!
+
+## Uninstalling binary install
+
+If you need to uninstall Ignition or switch to a source-based install once you
+have already installed the library from binaries, run the following command:
+
+```bash
+brew uninstall ignition-fortress
+```
+
+## Troubleshooting
+
+See [Troubleshooting](troubleshooting)