From 4e6ba841a25378e358ebafcdb20c592545e5097c Mon Sep 17 00:00:00 2001 From: Jesse Gorzinski <17914061+ThePrez@users.noreply.github.com> Date: Wed, 7 Jun 2023 17:50:38 -0400 Subject: [PATCH] More documentation fixup --- CONTRIBUTING.md | 11 +++++++++++ docs/_sidebar.md | 4 +--- docs/{install/ibmi.md => install.md} | 0 docs/install/any.md | 21 --------------------- 4 files changed, 12 insertions(+), 24 deletions(-) rename docs/{install/ibmi.md => install.md} (100%) delete mode 100644 docs/install/any.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2d1d6c6..9192edd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,6 +36,17 @@ After you install Manzan with the makefiles: * The configuration files (`.ini` extension) get created in `/QOpenSys/etc/manzan/` * Manzan can be started with `/opt/manzan/bin/manzan` + +## Building the Distributor component only via Maven + +1. `cd Manzan/camel` +2. `mvn compile` + * builds camel into the `camel/target` directory +3. `mvn exec:java` + * this starts the Distributor up on the system. + * If it is run for the first time, it will create empty configuration files (`.ini` extension) into the working directory + + ### Build Distributor (camel) only To build only the camel component, you can use `camel` as the target: diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 53e0221..d70509a 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -1,8 +1,6 @@ * [Home](/) -* Install - * [IBM i](install/ibmi.md) - * [Other](install/any.md) +* [Install](install.md) * [Configuration](config/index.md) * [Manzan](config/app.md) * [Data Sources](config/data.md) diff --git a/docs/install/ibmi.md b/docs/install.md similarity index 100% rename from docs/install/ibmi.md rename to docs/install.md diff --git a/docs/install/any.md b/docs/install/any.md deleted file mode 100644 index 10bcc6f..0000000 --- a/docs/install/any.md +++ /dev/null @@ -1,21 +0,0 @@ -This document will cover installing on non-IBM i environments, such as Windows or Linux. - -When running Manzan on non-IBM i environments, the provided makefiles cannot be used. The Handler (ILE component) can only be run on IBM i and the Distributor (Camel component) can run anywhere. - -## Requirements - -To build the camel component, Java and Maven must be setup and on the path so the shell can access them. - -## Build - -1. `cd Manzan/camel` -2. `mvn compile` - * builds camel into the `camel/target` directory -3. `mvn exec:java` - * this starts the Distributor up on the system. - * If it is run for the first time, it will create empty configuration files (`.ini` extension) into the working directory - -## Next steps - -* Read more about the [configuration files](/config/index.md) -* Build your very first [handler](/examples/file.md) \ No newline at end of file