diff --git a/.gitignore b/.gitignore index df22b176..76b55e70 100644 --- a/.gitignore +++ b/.gitignore @@ -2,7 +2,6 @@ .omv/ .ssh/ .vagrant/ -mgmt-documentation.pdf old/ tmp/ *_stringer.go diff --git a/Makefile b/Makefile index f266bbff..dee074be 100644 --- a/Makefile +++ b/Makefile @@ -138,8 +138,8 @@ format: gofmt yamlfmt docs: $(PROGRAM)-documentation.pdf -$(PROGRAM)-documentation.pdf: DOCUMENTATION.md - pandoc DOCUMENTATION.md -o '$(PROGRAM)-documentation.pdf' +$(PROGRAM)-documentation.pdf: docs/documentation.md + pandoc docs/documentation.md -o docs/'$(PROGRAM)-documentation.pdf' # # build aliases diff --git a/README.md b/README.md index d7933d24..de8d927e 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/purpleidea/mgmt)](https://goreportcard.com/report/github.com/purpleidea/mgmt) [![Build Status](https://secure.travis-ci.org/purpleidea/mgmt.png?branch=master)](http://travis-ci.org/purpleidea/mgmt) -[![Documentation](https://img.shields.io/docs/markdown.png)](DOCUMENTATION.md) +[![Documentation](https://img.shields.io/docs/markdown.png)](docs/documentation.md) [![GoDoc](https://godoc.org/github.com/purpleidea/mgmt?status.svg)](https://godoc.org/github.com/purpleidea/mgmt) [![IRC](https://img.shields.io/irc/%23mgmtconfig.png)](https://webchat.freenode.net/?channels=#mgmtconfig) [![Jenkins](https://img.shields.io/jenkins/status.png)](https://ci.centos.org/job/purpleidea-mgmt/) @@ -23,7 +23,7 @@ With your help you'll be able to influence our design and get us there sooner! ## Questions: Please join the [#mgmtconfig](https://webchat.freenode.net/?channels=#mgmtconfig) IRC community! -If you have a well phrased question that might benefit others, consider asking it by sending a patch to the documentation [FAQ](https://github.com/purpleidea/mgmt/blob/master/DOCUMENTATION.md#usage-and-frequently-asked-questions) section. I'll merge your question, and a patch with the answer! +If you have a well phrased question that might benefit others, consider asking it by sending a patch to the documentation [FAQ](https://github.com/purpleidea/mgmt/blob/master/docs/documentation.md#usage-and-frequently-asked-questions) section. I'll merge your question, and a patch with the answer! ## Quick start: * Make sure you have golang version 1.6 or greater installed. @@ -49,7 +49,7 @@ cd $GOPATH/src/github.com/purpleidea/mgmt Please look in the [examples/](examples/) folder for more examples! ## Documentation: -Please see: the manually created [DOCUMENTATION.md](DOCUMENTATION.md) (also available as [PDF](https://pdfdoc-purpleidea.rhcloud.com/pdf/https://github.com/purpleidea/mgmt/blob/master/DOCUMENTATION.md)) and the automatically generated [GoDoc documentation](https://godoc.org/github.com/purpleidea/mgmt). +Please see: the manually created [documentation.md](docs/documentation.md) (also available as [PDF](https://pdfdoc-purpleidea.rhcloud.com/pdf/https://github.com/purpleidea/mgmt/blob/master/docs/documentation.md)) and the automatically generated [GoDoc documentation](https://godoc.org/github.com/purpleidea/mgmt). ## Roadmap: Please see: [TODO.md](TODO.md) for a list of upcoming work and TODO items. diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 00000000..256be174 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +mgmt-documentation.pdf diff --git a/DOCUMENTATION.md b/docs/documentation.md similarity index 99% rename from DOCUMENTATION.md rename to docs/documentation.md index 67dfbd0c..51364704 100644 --- a/DOCUMENTATION.md +++ b/docs/documentation.md @@ -23,7 +23,7 @@ along with this program. If not, see . ####Available from: ####[https://github.com/purpleidea/mgmt/](https://github.com/purpleidea/mgmt/) -####This documentation is available in: [Markdown](https://github.com/purpleidea/mgmt/blob/master/DOCUMENTATION.md) or [PDF](https://pdfdoc-purpleidea.rhcloud.com/pdf/https://github.com/purpleidea/mgmt/blob/master/DOCUMENTATION.md) format. +####This documentation is available in: [Markdown](https://github.com/purpleidea/mgmt/blob/master/docs/documentation.md) or [PDF](https://pdfdoc-purpleidea.rhcloud.com/pdf/https://github.com/purpleidea/mgmt/blob/master/docs/documentation.md) format. ####Table of Contents diff --git a/Puppet.md b/docs/puppet.md similarity index 99% rename from Puppet.md rename to docs/puppet.md index f8fb4286..1cfc691c 100644 --- a/Puppet.md +++ b/docs/puppet.md @@ -14,7 +14,7 @@ This document goes into detail on how this works, and lists some pitfalls and limitations. For basic instructions on how to use the Puppet support, see -the [main documentation](DOCUMENTATION.md#puppet-support). +the [main documentation](documentation.md#puppet-support). ##Prerequisites