index.mdwn


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
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:

  - <http://wiki.baserock.org/overview/>
  - <http://wiki.baserock.org/moving-parts/>

## 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.