From e6f4471b33389ddaff500840f69f0d60cc3fa443 Mon Sep 17 00:00:00 2001 From: Seth Grover Date: Thu, 22 Sep 2022 21:32:15 -0600 Subject: [PATCH] experimenting with github pages --- docs/README.md | 2 +- docs/development.md | 4 ++++ docs/malcolm-preparation.md | 10 ++++++++++ docs/quickstart.md | 4 ++++ 4 files changed, 19 insertions(+), 1 deletion(-) create mode 100644 docs/malcolm-preparation.md diff --git a/docs/README.md b/docs/README.md index 79838bb83..2478b880f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -22,7 +22,7 @@ For smaller networks, use at home by network security enthusiasts, or in the fie * [Development](development.md#Development) * [Building from source](development.md#Build) * [Pre-Packaged installation files](development.md#Packager) -* Preparing your system +* [Configuration](malcolm-preparation.md#Configuration) * [Recommended system requirements](system-requirements.md#SystemRequirements) * [Malcolm Configuration](malcolm-config.md#ConfigAndTuning) * [`docker-compose.yml` parameters](malcolm-config.md#DockerComposeYml) diff --git a/docs/development.md b/docs/development.md index e39cc7a02..a2c37fa50 100644 --- a/docs/development.md +++ b/docs/development.md @@ -1,5 +1,9 @@ ## Development +* [Development](#Development) + * [Building from source](#Build) + * [Pre-Packaged installation files](#Packager) + Checking out the [Malcolm source code](https://github.com/idaholab/Malcolm/tree/main) results in the following subdirectories in your `malcolm/` working copy: * `api` - code and configuration for the `api` container which provides a REST API to query Malcolm diff --git a/docs/malcolm-preparation.md b/docs/malcolm-preparation.md new file mode 100644 index 000000000..f1d4fb4fb --- /dev/null +++ b/docs/malcolm-preparation.md @@ -0,0 +1,10 @@ +### Configuration + +* [Configuration](#Configuration) + * [Recommended system requirements](system-requirements.md#SystemRequirements) + * [Malcolm Configuration](malcolm-config.md#ConfigAndTuning) + * [`docker-compose.yml` parameters](malcolm-config.md#DockerComposeYml) + * [Platform-specific Configuration](host-config.md#HostSystemConfig) + * [Linux host system configuration](host-config-linux.md#HostSystemConfigLinux) + * [macOS host system configuration](host-config-macos.md#HostSystemConfigMac) + * [Windows host system configuration](host-config-windows.md#HostSystemConfigWindows) \ No newline at end of file diff --git a/docs/quickstart.md b/docs/quickstart.md index 612f397f5..aedc3d688 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -1,5 +1,9 @@ ## Quick start +* [Quick start](#QuickStart) + * [Getting Malcolm](#GetMalcolm) + * [User interface](#UserInterfaceURLs) + ### Getting Malcolm For a `TL;DR` example of downloading, configuring, and running Malcolm on a Linux platform, see [Installation example using Ubuntu 22.04 LTS](ubuntu-install-example.md#InstallationExample).