lourenco/mgmt
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Add an introductory paragraph to the quick start guide

Browse Source
This commit is contained in:
James Shubin
2017-01-16 11:09:33 -05:00
parent 0538f0c524
commit e97bba0524
2 changed files with 10 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -28,8 +28,8 @@ Please read, enjoy and help improve our documentation!
| documentation | additional notes | | documentation | additional notes |
|---|---| |---|---|
| [quick start guide](docs/quick-start-guide.md) | for mgmt newcomers |
| [general documentation](docs/documentation.md) | for everyone | | [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 | | [resource guide](docs/resource-guide.md) | for mgmt developers |
| [godoc API reference](https://godoc.org/github.com/purpleidea/mgmt) | for mgmt developers | | [godoc API reference](https://godoc.org/github.com/purpleidea/mgmt) | for mgmt developers |
| [puppet guide](docs/puppet.md) | for puppet sysadmins | | [puppet guide](docs/puppet.md) | for puppet sysadmins |

9
docs/quick-start-guide.md
View File

@@ -27,12 +27,21 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
####Table of Contents ####Table of Contents
0. [Introduction](#introduction)
1. [Dependencies](#dependencies) 1. [Dependencies](#dependencies)
2. [Quick start](#quick-start) 2. [Quick start](#quick-start)
3. [Examples](#examples) 3. [Examples](#examples)
4. [Installation](#installation) 4. [Installation](#installation)
5. [Authors - Authors and contact information](#authors) 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: ## Dependencies:
Software projects have a few different kinds of dependencies. There are _build_ Software projects have a few different kinds of dependencies. There are _build_
dependencies, _runtime_ dependencies, and additionally, a few extra dependencies dependencies, _runtime_ dependencies, and additionally, a few extra dependencies