COOK-821 - convert rdoc readmes to markdown and include starter template

chef-boneyard · Dec 6, 2011 · e875bc2 · e875bc2
1 parent 39f696b
commit e875bc2
Show file tree

Hide file tree

Showing 34 changed files with 717 additions and 365 deletions.
diff --git a/unicorn/README.rdoc → README-template.md b/unicorn/README.rdoc → README-template.md
@@ -1,8 +1,51 @@
-= LICENSE AND AUTHOR:
+Description
+===========
 
-Author:: Adam Jacob <adam@opscode.com>
 
-Copyright 2009-2010, Opscode, Inc.
+
+Changes
+=======
+
+
+
+## v 0.0.0
+
+Requirements
+============
+
+
+Attributes
+==========
+
+
+
+Recipes
+=======
+
+
+
+default
+-------
+
+Resources/Providers
+===================
+
+
+
+Usage
+=====
+
+
+
+Examples
+--------
+
+License and Author
+==================
+
+Author:: AUTHOR_NAME
+
+Copyright:: YYYY, Opscode, Inc
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/boost/README.rdoc → boost/README.md b/boost/README.rdoc → boost/README.md
@@ -1,23 +1,36 @@
-= DESCRIPTION:
+Description
+===========
 
 Installs boost, mainly to support Thrift.
 
-= REQUIREMENTS:
+Changes
+=======
 
-Platform: Ubuntu 9.04. Not tested on any others at this time.
+## v0.1.0:
 
-= USAGE:
+* Current public release.
+
+Requirements
+============
+
+## Platform:
+
+* Ubuntu 10.04
+
+Usage
+=====
 
 Include this recipe to install boost development packages.
 
-  include_recipe "boost"
+    include_recipe "boost"
 
 Merely installs the libboost-dev package which should grab a bunch of dependencies and get the right thing.
 
-= LICENSE and AUTHOR:
+License and Author
-
+==================
 
 Author:: Joshua Timberman (<joshua@opscode.com>)
+
 Copyright:: 2009, Opscode, Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");

diff --git a/boost/metadata.rb b/boost/metadata.rb
@@ -2,7 +2,7 @@
 maintainer_email "cookbooks@opscode.com"
 license          "Apache 2.0"
 description      "Installs libboost"
-long_description IO.read(File.join(File.dirname(__FILE__), 'README.rdoc'))
+long_description IO.read(File.join(File.dirname(__FILE__), 'README.md'))
 version          "0.1"
 recipe           "boost", "Installs libboost-dev"
 

diff --git a/gems/README.rdoc → gems/README.md b/gems/README.rdoc → gems/README.md
@@ -1,45 +1,59 @@
-= DESCRIPTION:
+Description
+===========
 
 Sets up a local gem server repository.
 
-= REQUIREMENTS:
+Changes
+=======
 
-== Platform:
+## v1.0.0:
 
-Tested on Ubuntu 8.10 and 9.04.
+* Current public release.
 
-== Cookbooks:
+Requirements
+============
 
-Opscode cookbooks, http://github.com/opscode/cookbooks/tree/master
+## Platform:
+
+* Ubuntu 9.04, 8.10
+
+## Cookbooks:
 
 * apache2
+* rsync
 
-= ATTRIBUTES: 
+Attributes
+==========
 
-* gem_server[:virtual_host_name] - ServerName for Apache vhost. Default 'gems.domain'.
+* `gem_server[:virtual_host_name]` - ServerName for Apache vhost.
-* gem_server[:virtual_host_alias] - ServerAlias(es) for Apache vhost. Default 'gems'.
+  Default 'gems.domain'.
-* gem_server[:directory] - Filesystem location for the repository, default is /srv/gems.
+* `gem_server[:virtual_host_alias]` - ServerAlias(es) for Apache vhost.
+  Default 'gems'.
+* `gem_server[:directory]` - Filesystem location for the repository,
+  default is /srv/gems.
 
-= USAGE:
+Usage
+=====
 
 Create files/default/packages, and copy gems to that directory.
 
 Specify the gem source on clients via the command line, for example:
 
-  sudo gem source -a http://gems
+    sudo gem source -a http://gems
-  sudo gem install rails --source http://gems
+    sudo gem install rails --source http://gems
 
 Or use the source with gem_package resources in your chef recipes.
 
-  gem_package "rails" do
+    gem_package "rails" do
-    source "http://gems"
+      source "http://gems"
-  end
+    end
 
 Use the gems::mirror recipe to mirror RubyForge. This will take a long time because the repository is 28k+ gems and over 5.5G. It will also override the remote_directory resource to not notify gem generate_index, and instead handle that in the cron job that does the rsync.
 
-= LICENSE and AUTHOR:
+License and Author
-
+==================
-Author:: Joshua Timberman (<joshua@opscode.com>)
+
+Author:: Joshua Timberman <joshua@opscode.com>
 
 Copyright:: 2009, Opscode, Inc
 
@@ -53,4 +67,4 @@ Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
-limitations under the License.
+limitations under the License.
diff --git a/gems/metadata.rb b/gems/metadata.rb
@@ -2,7 +2,7 @@
 maintainer_email  "cookbooks@opscode.com"
 license           "Apache 2.0"
 description       "Sets up a local gem server repository or mirror"
-long_description  IO.read(File.join(File.dirname(__FILE__), 'README.rdoc'))
+long_description  IO.read(File.join(File.dirname(__FILE__), 'README.md'))
 version           "1.0.0"
 recipe            "gems", "Empty, use one of the other recipes"
 recipe            "gems::server", "Sets up a local gem server repository"

diff --git a/git/README.rdoc → git/README.md b/git/README.rdoc → git/README.md
@@ -1,25 +1,42 @@
-= DESCRIPTION:
+Description
+===========
 
-Installs git.
+Installs git and optionally sets up a git server as a daemon under runit.
 
-= REQUIREMENTS:
+Changes
+=======
 
-== Cookbooks:
+## v0.9.0:
 
-Opscode Cookbooks (http://github.com/opscode/cookbooks/tree/master)
+* Current public release.
+
+Requirements
+============
+
+## Platform:
+
+* Debian/Ubuntu
+* ArchLinux
+
+## Cookbooks:
 
 * runit
 
-= USAGE:
+Usage
+=====
+
+This cookbook primarily installs git core packages. It can also be
+used to serve git repositories.
 
-This cookbook primarily installs git core packages. It can also be used to serve git repositories.
+    include_recipe "git::server"
 
-  include_recipe "git::server"
+This creates the directory /srv/git and starts a git daemon, exporting
+all repositories found. Repositories need to be added manually, but
+will be available once they are created.
 
-This creates the directory /srv/git and starts a git daemon, exporting all repositories found. Repositories need to be added manually, but will be available once they are created.
+License and Author
+==================
 
-= LICENSE and AUTHOR:
-
 Author:: Joshua Timberman (<joshua@opscode.com>)
 
 Copyright:: 2009, Opscode, Inc
@@ -34,4 +51,4 @@ Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
-limitations under the License.
+limitations under the License.
diff --git a/git/metadata.rb b/git/metadata.rb
@@ -2,7 +2,7 @@
 maintainer_email  "cookbooks@opscode.com"
 license           "Apache 2.0"
 description       "Installs git and/or sets up a Git server daemon"
-long_description  IO.read(File.join(File.dirname(__FILE__), 'README.rdoc'))
+long_description  IO.read(File.join(File.dirname(__FILE__), 'README.md'))
 version           "0.9.0"
 recipe            "git", "Installs git"
 recipe            "git::server", "Sets up a runit_service for git daemon"

diff --git a/god/README.md b/god/README.md
@@ -0,0 +1,58 @@
+Description
+===========
+
+Installs god gem, sets up modular configuration directory and provides
+a defininition to monitor processes.
+
+Changes
+=======
+
+## v1.0.0:
+
+* Current public release.
+
+Requirements
+============
+
+Sample configuration file uses mongrel_runit for managing mongrels via
+runit. Opscode does not have a `mongrel_runit` cookbook, however.
+
+## Platform:
+
+* Debian/Ubuntu
+
+
+## Cookbooks:
+
+* runit
+
+Usage
+=====
+
+This recipe is designed to be used through the `god_monitor` define. Create a god configuration file in your application's cookbook and then call `god_monitor`:
+
+    god_monitor "myproj" do
+      config "myproj.god.erb"
+    end
+
+A sample mongrel.god.erb is provided, though it assumes `mongrel_runit` is used. This can be used as a baseline for customization.
+
+
+License and Author
+==================
+
+Author:: Joshua Timberman (<joshua@opscode.com>)
+
+Copyright:: 2009, Opscode, Inc
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/god/README.rdoc b/god/README.rdoc
diff --git a/god/metadata.rb b/god/metadata.rb
@@ -2,7 +2,7 @@
 maintainer_email  "cookbooks@opscode.com"
 license           "Apache 2.0"
 description       "Installs and configures god and provides a define for monitoring"
-long_description  IO.read(File.join(File.dirname(__FILE__), 'README.rdoc'))
+long_description  IO.read(File.join(File.dirname(__FILE__), 'README.md'))
 version           "1.0.0"
 
 recipe "god", "Installs god and starts it as a runit service"