Fixup sources.d.n setup
[mirror/dsa-puppet.git] / README.md
1 # dsa-puppet
2
3 ## Reference Documentation
4
5 - [Puppet Language: Summary][1]
6 - [Puppet Language: Type Reference][2]
7 - [Puppet Language: Function Reference][3]
8
9 ## HOWTOs
10
11 ### how to deploy a development environment
12
13     apt-get install facter   # >= 1.6.2
14     apt-get install puppet   # >= 2.7.6
15     apt-get install pcregrep
16     apt-get install puppet-lint
17     git clone ssh://username@puppet.debian.org/srv/puppet.debian.org/git/dsa-puppet.git /path/to/local/repo
18     make -C /path/to/local/repo git_hooks  # CRITICAL
19
20 ### how to validate manifest files
21
22     puppet parser validate </path/to/manifest/file>
23     puppet-lint --no-2sp_soft_tabs-check --no-hard_tabs-check --no-80chars-check </path/to/manifest/file>
24
25 ### how to test changes
26
27 Once you commit your changes and push them to the primary repository, you
28 can test your changes on a Debian machine using:
29
30     puppet agent --test --noop
31
32 Note, however, that once the changes are pushed, the changes are live to
33 all Debian machines and it is only a matter of time for the agent to run.
34
35 ### how to configure vim
36
37 For Vim users, tools/vim contains some files that make life easier. You may
38 install them into your ~/.vim using:
39
40     make -C /path/to/local/repo vim_helpers
41
42 Alternately, use [gmarik/vundle][4] or [tpope/pathogen][5] to install
43 [rodjek/vim-puppet][6].
44
45
46 [1]: http://docs.puppetlabs.com/puppet/latest/reference/lang_summary.html
47 [2]: http://docs.puppetlabs.com/references/stable/type.html
48 [3]: http://docs.puppetlabs.com/references/stable/function.html
49 [4]: https://github.com/gmarik/vundle
50 [5]: https://github.com/tpope/vim-pathogen
51 [6]: https://github.com/rodjek/vim-puppet