Permalink
Browse files

Switched README to proper markdown format.

  • Loading branch information...
1 parent 34d9324 commit d9e326747f27c804e3a7dd251fc24a342f7d680b Ben Rockwood committed Sep 21, 2012
Showing with 11 additions and 14 deletions.
  1. +11 −14 README.md
View
25 README.md
@@ -1,32 +1,29 @@
smartos_cookbooks
=================
-Chef Cookbooks and tools for use with SmartOS. This is intended for management of the Global Zone, not SmartMachines (NGZs).
+Chef Cookbooks and tools for use with SmartOS.
-For details about how to use this repository, please refer to http://wiki.smartos.org/display/DOC/Using+Chef
-
-
-ABOUT THE TOOLS
----------------
+This is intended for management of the Global Zone, not SmartMachines (Non-Global Zones). For cookbooks and tools to be used with SmartMachines/NGZ's, please see the [joyent/smartmachine_cookbooks](https://github.com/joyent/smartmachine_cookbooks) repository instead.
-cookbooks:: Indivial SmartOS cookbooks. The "smartos" cookbook itself is considered the primary cookbooks applied to all
- nodes and should be the first one included in the run_list.
-
-knife_bootstrap:: Bootstrap templates for Knife.
+For details about how to use this repository, please refer to http://wiki.smartos.org/display/DOC/Using+Chef
-nodes:: Chef node attribute files.
-smf:: SmartOS SMF XML manifests for Chef Solo & Chef Client
+REPOSITORY LAYOUT
+-----------------
-scripts:: Chef Solo bootstrap scripts to simplify deployment.
+* **cookbooks**: Indivial SmartOS cookbooks. The "smartos" cookbook itself is considered the primary cookbooks applied to all nodes and should be the first one included in the run_list.
+* **knife_bootstrap**: Bootstrap templates for Knife.
+* **nodes**: Chef node attribute files.
+* **smf**: SmartOS SMF XML manifests for Chef Solo & Chef Client
+* **scripts**: Chef Solo bootstrap scripts to simplify deployment.
For Chef Solo users, a *Makefile* is included to transfer the contents of the repsitory to a web server for distribution.
DISLAIMER
---------
-These cookbooks are unofficial and not supported by Joyent or its partners. Please use at your own risk.
+These tools and cookbooks are unofficial and not supported by Joyent or its partners. Please use at your own risk.
TODO

0 comments on commit d9e3267

Please sign in to comment.