Jianwei Han / my-boxen

Download as
Browse Code ยป

Commit f1700e913a8b727bd75f273bf04cfd69ec7a9f7f

Authored by Will Farrington
2 parents 049d55af73 b9eac9217a

Merge pull request #23 from vinbarnes/patch-1 

minor README cleanup

Showing 1 changed file Side-by-side Diff

... ... @@ -108,11 +108,11 @@
108 108 Boxen runs everything declared in `manifests/site.pp` by default.
109 109 But just like any other source code, throwing all your work into one massive
110 110 file is going to be difficult to work with. Instead, we recommend you
111   -use modules via the `Puppetfile` when you can and making new modules
112   -in the `modules/` directory when you can't. Then you just need to
113   -`include $modulename` those modules in `manifests/site.pp`. One pattern
114   -that's very common is to create a module for your organization
115   -(eg. `modules/github`) and put an environment class in that module
  111 +use modules in the `Puppetfile` when you can and make new modules
  112 +in the `modules/` directory when you can't. Then add `include $modulename`
  113 +for each new module in `manifests/site.pp` to include them.
  114 +One pattern that's very common is to create a module for your organization
  115 +(e.g., `modules/github`) and put an environment class in that module
116 116 to include all of the modules your organization wants to install for
117 117 everyone by default. An example of this might look like so:
118 118  
... ... @@ -128,7 +128,7 @@
128 128 }
129 129 ```
130 130  
131   - If you'd like to read more about how Puppet works, we recommend
  131 + If you'd like to read more about how Puppet works, we recommend
132 132 checking out [the official documentation](http://docs.puppetlabs.com/)
133 133 for:
134 134  
... ... @@ -139,7 +139,7 @@
139 139  
140 140 ### Creating a personal module
141 141  
142   -See [the documentation in the
  142 +See [the documentation in the
143 143 `modules/people`](https://github.com/boxen/our-boxen/blob/master/modules/people/README.md)
144 144 directory for creating per-user modules that don't need to be applied
145 145 globally to everyone.
... ... @@ -148,7 +148,7 @@
148 148  
149 149 See [the documentation in the
150 150 `modules/projects`](https://github.com/boxen/our-boxen/blob/master/modules/projects/README.md)
151   -directory for creating organization projects (read: repositories that people
  151 +directory for creating organization projects (i.e., repositories that people
152 152 will be working in).
153 153  
154 154 ## Binary packages