minor cleanup
Fix typos. Clarify module includes in the Puppetfile.
This commit is contained in:
parent
049d55af73
commit
b9eac9217a
1 changed files with 8 additions and 8 deletions
12
README.md
12
README.md
|
@ -108,11 +108,11 @@ node default {
|
||||||
Boxen runs everything declared in `manifests/site.pp` by default.
|
Boxen runs everything declared in `manifests/site.pp` by default.
|
||||||
But just like any other source code, throwing all your work into one massive
|
But just like any other source code, throwing all your work into one massive
|
||||||
file is going to be difficult to work with. Instead, we recommend you
|
file is going to be difficult to work with. Instead, we recommend you
|
||||||
use modules via the `Puppetfile` when you can and making new modules
|
use modules in the `Puppetfile` when you can and make new modules
|
||||||
in the `modules/` directory when you can't. Then you just need to
|
in the `modules/` directory when you can't. Then add `include $modulename`
|
||||||
`include $modulename` those modules in `manifests/site.pp`. One pattern
|
for each new module in `manifests/site.pp` to include them.
|
||||||
that's very common is to create a module for your organization
|
One pattern that's very common is to create a module for your organization
|
||||||
(eg. `modules/github`) and put an environment class in that module
|
(e.g., `modules/github`) and put an environment class in that module
|
||||||
to include all of the modules your organization wants to install for
|
to include all of the modules your organization wants to install for
|
||||||
everyone by default. An example of this might look like so:
|
everyone by default. An example of this might look like so:
|
||||||
|
|
||||||
|
@ -148,7 +148,7 @@ globally to everyone.
|
||||||
|
|
||||||
See [the documentation in the
|
See [the documentation in the
|
||||||
`modules/projects`](https://github.com/boxen/our-boxen/blob/master/modules/projects/README.md)
|
`modules/projects`](https://github.com/boxen/our-boxen/blob/master/modules/projects/README.md)
|
||||||
directory for creating organization projects (read: repositories that people
|
directory for creating organization projects (i.e., repositories that people
|
||||||
will be working in).
|
will be working in).
|
||||||
|
|
||||||
## Binary packages
|
## Binary packages
|
||||||
|
|
Loading…
Reference in a new issue