From 29457450049b50dca16b33d65ef6dfff2d92d27c Mon Sep 17 00:00:00 2001 From: Sam Thursfield Date: Mon, 29 Feb 2016 17:28:24 +0000 Subject: Allow rendering the spec as a website The website isn't too pretty so far (especially when Javascript is disabled), help welcome on that front. It should be usable though. You can install mkdocs and the mkdocs-material theme from PyPI, then run `mkdocs serve` to test changes locally. Change-Id: Iaa33f936310f6e126f50e095e0b924babbdd8540 --- index.mdwn | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 index.mdwn (limited to 'index.mdwn') diff --git a/index.mdwn b/index.mdwn new file mode 100644 index 0000000..7f5dd63 --- /dev/null +++ b/index.mdwn @@ -0,0 +1,42 @@ +# Welcome to the Baserock Project's documentation! + +Baserock is about improving how we build, integrate and maintain collections of +software. + +For more information, see these pages on the wiki: + + - + - + +## The Baserock definitions format + +The Baserock definitions format is a way of specifying components that +need to be built, deployed and distributed in some way. + +The current format is described in the [Spec](spec) section. + +Historical changes are listed in the [Changelog](changelog). + +To propose changes to the version, please submit patches against 'master' of +the [spec.git repo](http://git.baserock.org/cgit/baserock/baserock/spec.git). +See the [contributing](http://wiki.baserock.org/contributing/) page for +information. If you send a patch to Gerrit for a major change, please notify +the baserock-dev@baserock.org mailing list too. + +The wiki has more [information on the Definitions +format](http://wiki.baserock.org/definitions/), including a [comparison with +other +formats](http://wiki.baserock.org/definitions/comparison-with-other-formats), +and a [style guide](http://wiki.baserock.org/definitions/best-practices). + +## The Baserock reference definitions + +We maintain a collection of definitions describing how to build lots of popular +free software components. These are in a repository at +[git.baserock.org/baserock/baserock/definitions](http://git.baserock.org/cgit/baserock/baserock/definitions.git/tree/). + +When modifying or defining your own Baserock systems, normally you will 'fork' +this repository and use Git tooling to keep your changes in sync with ours. + +It's also possible to write definitions completely independently of ours, if +you want. -- cgit v1.2.1