From 71b530fe92b69ed9a77fefd3824cdac524d614e9 Mon Sep 17 00:00:00 2001 From: Ryan Moran Date: Tue, 10 Jan 2017 15:27:41 -0800 Subject: [PATCH] Some fixing up and linking for EXAMPLE doc --- docs/EXAMPLE.md | 2 +- docs/README.md | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/EXAMPLE.md b/docs/EXAMPLE.md index 088f88db9..9198d293e 100644 --- a/docs/EXAMPLE.md +++ b/docs/EXAMPLE.md @@ -7,7 +7,7 @@ details when following this example. ## 1. Boot your Ops Manager VM. This can be done with the existing `opsmgr` tooling. - For the purposes of this example we will have an Ops Manager VM located at https://opsman.example.com. + For the purposes of this example we will have an Ops Manager VM located at `https://opsman.example.com`. ## 2. Configure the authentication mechanism for the Ops Manager. diff --git a/docs/README.md b/docs/README.md index 7bbd142c5..f4ee58bc3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,3 +1,9 @@ +# Usage Example + +An example of how you might use `om` to install a product can be found [here](EXAMPLE.md). +The example will show some configuration that could apply to installing the Elastic Runtime +on a vSphere Ops Manager. + # Commands * [apply-changes](apply-changes/README.md) * [available-products](available-products/README.md)