knife-cookbook-doc 0.6.0 → 0.7.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzYzNWY1YTQ5YjdhODMzM2Q0NzNmYmNkYmY2MWUyZGZkYjJiYTZiMw==
+    ZGM3MTZiNmYzYTVkOTYwMzUzYjRmMjI0OGZkMGMwMTZkMTg4ZGU4YQ==
   data.tar.gz: !binary |-
-    ZjY1MWNjMjEwYThlN2QxYjU3ZTk2NzVjZjk1ODA2YmI5NzI4ZGY0MA==
+    MjkxZTJiOWUzMmM3ZTVmYjE5YWVlNjE5ZDA0MGM5YzhiNWIyY2Q0OQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    OWUzOWUyYzlmMGNmY2YyNDhkZThhNDYwM2ZhMjJkZWNkNTdiNzk0MjA0OGZk
-    MmY3ZjQwODA2NTg5NjE0YWQ2Y2I3Y2JlNGVjZDUzZDRmODNkZDAzYzUzNGE2
-    MzUwNmFhNTAwNzMyM2ZkMWE1OTBjNDU4MWI0MjYxZmVmNzA3NjM=
+    ZTQxZTVlNzIwMDU3Y2YyMjFlMmY2ZmQxNmJiYzhlYTExMDBiZjBlNWNhMDA3
+    OGY4NDI0ZjIzMGUwZDVmN2FlNTI5Y2I4YWZlOGFlM2ZlNGQ1NzFiNTk4NTRh
+    NTk3MDNiYTlhM2M5OThlZDFhMDRiYzdkZWU5MTFmM2NmMzI4Y2Q=
   data.tar.gz: !binary |-
-    OTlmZjA1MWM1NDI0OTQ5ZWJmNWMxNWRjN2Q2ZGI3OWQ2MjBiMTIxNzgxYjc1
-    ZGUwYjRkYTkzMDk5ZTNhMmNhYjg3ZDgzYmQyYjM4ZTU1NWM5YjRlNDE4Zjlm
-    OWNhZjU5OTE4ZWUyODIxZjQyMTRlZGZkYTViMzJjZmZkNTFlNzk=
+    MGFkM2U0MzhhYzkyOTQ4OTZlNzNmODY0Njg2MDc1MzYyNTM4ZjBlMDRmZTNk
+    M2VjYTg3YmNiMGE3ODZiZDg5YTAxOTVjNzRlOWI3ZTRjMWMxMTAyMjkzMzZj
+    M2IyOWFjNGM2NzBmMzRlZTIxYzUxZWYyZjI1MTQxNzhmNjc4Y2M=

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+v0.7.0 (Oct 13 2013)
+--------------------
+
+* Add some basic documentation regarding scanning documentation for attributes.
+
 v0.6.0  (Oct 7 2013)
 --------------------
 

data/README.md

@@ -16,8 +16,10 @@ it's currency.
 
 Populate the `metadata.rb` of your cookbook according to Opscode's
 [documentation](http://docs.opscode.com/config_rb_metadata.html). Particular
-attention should be paid to documenting the recipes, attributes, platform
-compatibility and cookbook requirements (i.e. depends, recommends, suggests etc).
+attention should be paid to documenting the platform compatibility and
+cookbook requirements (i.e. depends, recommends, suggests etc). Documentation
+for attributes and recipes can either be derived from scanning the source
+code or by explicit declaration in `metadata.rb`.
 
 #### Step 2
 
@@ -29,6 +31,19 @@ At the top of each recipe, add a detailed documentation section such as;
     #>
     =end
 
+If the user has not specified documentation for the recipe in `metadata.rb`
+then the tool takes the first sentence of the detailed documentation as the
+summary to use in the table of contents.
+
+#### Step 2
+
+If the user has not specified documentation for the attributes in `metadata.rb`
+then the tool scans the attribute files and uses the documentation block
+preceding the attribute.
+
+    #<> MyApp Admin Group: The group allowed to manage MyApp.
+    default['myapp']['group'] = 'myapp-admin'
+
 #### Step 3
 
 In each LWRP, add detailed documentation such as;

data/lib/knife_cookbook_doc/version.rb

@@ -1,3 +1,3 @@
 module KnifeCookbookDoc
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-cookbook-doc
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Mathias Lafeldt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-07 00:00:00.000000000 Z
+date: 2013-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef