Jianwei Han / my-boxen

Download as
Browse Code ยป

Commit a970e15714f9b33194b069876bd63c0796110ac6

Authored by Gary Larizza
1 parent 97af892cc2

Update README.md according to style 

Previously, the README.md file was updated but didn't match existing
Github style. This commit wraps near 80 columns (markdown links make
that a bit harder) and eliminate unnecessary steps (linking to
existing documentation and removing redundant declarations).

Showing 1 changed file with 32 additions and 45 deletions Side-by-side Diff

... ... @@ -66,9 +66,14 @@
66 66 tested to be compatible with Boxen. Use the `Puppetfile` to pull them
67 67 in dependencies automatically whenever `boxen` is run.
68 68  
69   -### Node Definitions ###
  69 +### Node definitions
70 70  
71   -Puppet has the concept of a ['node'](http://docs.puppetlabs.com/references/glossary.html#agent), which is essentially the machine on which Puppet is running. Puppet looks for [node definitions](http://docs.puppetlabs.com/learning/agent_master_basic.html#node-definitions) in the `manifests/site.pp` file in the Boxen repo. You'll see a default node declaration that looks like the following:
  71 +Puppet has the concept of a
  72 +['node'](http://docs.puppetlabs.com/references/glossary.html#agent),
  73 +which is essentially the machine on which Puppet is running. Puppet looks for
  74 +[node definitions](http://docs.puppetlabs.com/learning/agent_master_basic.html#node-definitions)
  75 +in the `manifests/site.pp` file in the Boxen repo. You'll see a default node
  76 +declaration that looks like the following:
72 77  
73 78 node default {
74 79 # core modules, needed for most things
75 80  
76 81  
77 82  
78 83  
... ... @@ -76,49 +81,31 @@
76 81 <...>
77 82 }
78 83  
79   -All Puppet [class declarations](http://docs.puppetlabs.com/learning/modules1.html#classes) should be included in the default node definition. Theoretically, you _COULD_ declare every [Puppet resource](http://docs.puppetlabs.com/learning/ral.html) in the `manifests/site.pp` file, but that would quickly become unwieldy. Instead, it's easier to create [Puppet modules](http://docs.puppetlabs.com/learning/modules1.html#modules) inside the `modules` folder of the Boxen repo. Boxen is setup to discover any modules you create in the `modules` folder, and we've already created a `people` and `projects` module structure for you to start using.
  84 +All Puppet
  85 +[class declarations](http://docs.puppetlabs.com/learning/modules1.html#classes)
  86 +should be included in the default node definition. Theoretically, you _COULD_
  87 +declare every
  88 +[Puppet resource](http://docs.puppetlabs.com/learning/ral.html) in the
  89 +`manifests/site.pp` file, but that would quickly become unwieldy. Instead,
  90 +it's easier to create
  91 +[Puppet modules](http://docs.puppetlabs.com/learning/modules1.html#modules)
  92 +inside the `modules` folder of the Boxen repo. Boxen is setup to discover any
  93 +modules you create in the `modules` folder, and we've already created a
  94 +`people` and `projects` module structure for you to start using.
80 95  
81   -### Creating a personal module ###
  96 +### Creating a personal module
82 97  
83   -Using the `modules/people` folder that's been provided in the Boxen repo, start by creating a file in `modules/people/manifests` in the format of `your_last_name.pp` (Feel free to use the [Puppet module cheat sheet](http://docs.puppetlabs.com/module_cheat_sheet.pdf) if you need some extra help). If we were making a module for [Tim Sharpe](http://github.com/rodjek), we would create a file called `modules/people/manifests/sharpe.pp` that would look like the following:
  98 +See [the documentation in the
  99 +`modules/people`](https://github.com/boxen/our-boxen/blob/master/modules/people/README.md)
  100 +directory for creating per-user modules that don't need to be applied
  101 +globally to everyone.
84 102  
85   - # modules/people/manifests/sharpe.pp
86   - class people::sharpe {
87   - # Resource Declarations go here
88   - package { 'tree':
89   - ensure => installed,
90   - provider => homebrew,
91   - }
92   - }
  103 +### Creating a project module
93 104  
94   -This class is installing the `tree` package out of
95   -[Homebrew](https://github.com/mxcl/homebrew), but feel free to add whatever
96   -resource declarations you'll need. Finally, add the following line in the
97   -`manifests/site.pp` file within the default node definition:
98   -
99   - include people::sharpe
100   -
101   -Finally, run `boxen --noop` to [simulate, or
102   -test](http://docs.puppetlabs.com/guides/tests_smoke.html#running-tests) what
103   -changes your code would have made. If you're happy with how things look, you
104   -can then run `boxen` to enforce the changes you've made
105   -
106   -You'll have to
107   -make sure your "node" (Puppet's term for your laptop, basically)
108   -includes or requires them. You can do this by either modifying
109   -`manifests/site.pp` for each module, _or_ we would generally recommend
110   -you create a module for your organization (eg. `modules/github`) and
111   -create an environment class in that. Then you need only adjust
112   -`manifests/site.pp` by doing `include github::environment` or
113   -what-have-you for your organization.
114   -
115   -### Creating a project module ###
116   -
117   -The `modules/projects` folder is provided for organizational projects that
118   -aren't specific to one person. You're free to create any number of modules in
119   -the `modules` directory. As long as you follow Puppet's module naming patterns,
120   -everything should be fine. For more information, see the documentation in the
121   -projects module template that we provide.
  105 +See [the documentation in the
  106 +`modules/projects`](https://github.com/boxen/our-boxen/blob/master/modules/projects/README.md)
  107 +directory for creating organization projects (read: repositories that people
  108 +will be working in).
122 109  
123 110 ## Binary packages
124 111