knife-cookbook-doc 0.2.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/README.md +4 -4
- data/knife_cookbook_doc.gemspec +1 -1
- data/lib/chef/knife/README.md.erb +6 -1
- data/lib/knife_cookbook_doc/version.rb +1 -1
- metadata +2 -2
data/README.md
CHANGED
|
@@ -56,12 +56,12 @@ In each LWRP, add detailed documentation such as;
|
|
|
56
56
|
|
|
57
57
|
It should be noted that the documentation of the LWRP requires that the user
|
|
58
58
|
document the actions, using `@action <action> <description>` and the attributes
|
|
59
|
-
using `@attribute <attribute> <description
|
|
60
|
-
descriptions for the actions and attributes
|
|
59
|
+
using `@attribute <attribute> <description>`. This allows meaningful
|
|
60
|
+
descriptions for the actions and attributes to be added to the README.
|
|
61
61
|
|
|
62
|
-
The
|
|
62
|
+
The other text will be added at the start of the LWRP documentation
|
|
63
63
|
except if marked with `@section <heading>`, in which case it will be added
|
|
64
|
-
to the
|
|
64
|
+
to the end of the LWRP documentation.
|
|
65
65
|
|
|
66
66
|
#### Step 4
|
|
67
67
|
|
data/knife_cookbook_doc.gemspec
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
# -*- encoding: utf-8 -*-
|
|
2
|
-
require File.expand_path(
|
|
2
|
+
require File.expand_path("#{File.dirname(__FILE__)}/lib/knife_cookbook_doc/version")
|
|
3
3
|
|
|
4
4
|
Gem::Specification.new do |s|
|
|
5
5
|
s.authors = ['Mathias Lafeldt', 'Peter Donald']
|
|
@@ -112,11 +112,16 @@
|
|
|
112
112
|
|
|
113
113
|
<% end -%>
|
|
114
114
|
<% end -%>
|
|
115
|
-
<% fragments.keys.select {|k|k != 'overview'}.each do |key| -%>
|
|
115
|
+
<% fragments.keys.select {|k|k != 'overview' && k != 'credit'}.each do |key| -%>
|
|
116
116
|
<%= fragments[key] %>
|
|
117
|
+
|
|
117
118
|
<% end -%>
|
|
119
|
+
<% unless fragments['credit'] -%>
|
|
118
120
|
# License and Maintainer
|
|
119
121
|
|
|
120
122
|
Maintainer:: <%= maintainer %> (<<%= maintainer_email %>>)
|
|
121
123
|
|
|
122
124
|
License:: <%= license %>
|
|
125
|
+
<% else -%>
|
|
126
|
+
<%= fragments['credit'] -%>
|
|
127
|
+
<% end -%>
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: knife-cookbook-doc
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.3.0
|
|
5
5
|
prerelease:
|
|
6
6
|
platform: ruby
|
|
7
7
|
authors:
|
|
@@ -10,7 +10,7 @@ authors:
|
|
|
10
10
|
autorequire:
|
|
11
11
|
bindir: bin
|
|
12
12
|
cert_chain: []
|
|
13
|
-
date: 2013-04-
|
|
13
|
+
date: 2013-04-02 00:00:00.000000000 Z
|
|
14
14
|
dependencies:
|
|
15
15
|
- !ruby/object:Gem::Dependency
|
|
16
16
|
name: chef
|