From e97bba0524b617de1f4bd24fd15b9c42b2628653 Mon Sep 17 00:00:00 2001 From: James Shubin Date: Mon, 16 Jan 2017 11:09:33 -0500 Subject: [PATCH] docs: Add an introductory paragraph to the quick start guide --- README.md | 2 +- docs/quick-start-guide.md | 9 +++++++++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a788aaba..bbf0feba 100644 --- a/README.md +++ b/README.md @@ -28,8 +28,8 @@ Please read, enjoy and help improve our documentation! | documentation | additional notes | |---|---| -| [quick start guide](docs/quick-start-guide.md) | for mgmt newcomers | | [general documentation](docs/documentation.md) | for everyone | +| [quick start guide](docs/quick-start-guide.md) | for mgmt developers | | [resource guide](docs/resource-guide.md) | for mgmt developers | | [godoc API reference](https://godoc.org/github.com/purpleidea/mgmt) | for mgmt developers | | [puppet guide](docs/puppet.md) | for puppet sysadmins | diff --git a/docs/quick-start-guide.md b/docs/quick-start-guide.md index 760d1fc8..bdd25fd3 100644 --- a/docs/quick-start-guide.md +++ b/docs/quick-start-guide.md @@ -27,12 +27,21 @@ along with this program. If not, see . ####Table of Contents +0. [Introduction](#introduction) 1. [Dependencies](#dependencies) 2. [Quick start](#quick-start) 3. [Examples](#examples) 4. [Installation](#installation) 5. [Authors - Authors and contact information](#authors) +## Introduction: +This guide is intended for developers. Once `mgmt` is minimally viable, we'll +publish a quick start guide for users too. In the meantime, please contribute! +If you're brand new to `mgmt`, it's probably a good idea to start by reading the +[introductory article](https://ttboj.wordpress.com/2016/01/18/next-generation-configuration-mgmt/) +or to watch an [introductory video](https://github.com/purpleidea/mgmt/#on-the-web). +Once you're familiar with the general idea, please start hacking... + ## Dependencies: Software projects have a few different kinds of dependencies. There are _build_ dependencies, _runtime_ dependencies, and additionally, a few extra dependencies