knife-cookbook-doc 0.19.0 → 0.20.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -1
- data/README.md +5 -3
- data/lib/chef/knife/README.md.erb +5 -1
- data/lib/knife_cookbook_doc/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 2547fe3a4ed594bf06e9c563ae040c45c42001e3
|
|
4
|
+
data.tar.gz: 92629b1e4e30ab40b3646708eb3ab97328afcad7
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 5625b1d45f32c07f42ca21baf9512fba3e2cc75765b16c5debcf02d3f30cbf6a2be87238c62adc611c43c9b8f16f878a01a7221434bca77b7b985e8e7ea0433a
|
|
7
|
+
data.tar.gz: e4e821099a09abe61c24da3552a5c2c70fcf97af8e035a7b50117dd0712c5b5ad416d8de88566fd280d73514ddb239d81f9ecafb878eda0b948faf08562c0e9d
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
# v0.20.0 (Mar 11 2016)
|
|
2
|
+
|
|
3
|
+
* Support custom requirements being specified in `doc/requirements.md`. Submitted by Deepak Sihag.
|
|
4
|
+
|
|
1
5
|
# v0.19.0 (Dec 1 2015)
|
|
2
6
|
|
|
3
|
-
* Revert changes in 0.18.0 as it is not possible to support modern versions of
|
|
7
|
+
* Revert changes in 0.18.0 as it is not possible to support modern versions of chef and pre-2.0 versions of ruby.
|
|
4
8
|
|
|
5
9
|
# v0.18.0 (Dec 1 2015)
|
|
6
10
|
|
data/README.md
CHANGED
|
@@ -116,9 +116,11 @@ In each definition add documentation like:
|
|
|
116
116
|
Finally the user should add some documentation fragments into the `doc/` dir.
|
|
117
117
|
Most importantly you should add `doc/overview.md` which will replace the first
|
|
118
118
|
`Description` section of the readme. You should also add a `doc/credit.md` which
|
|
119
|
-
will replace the last 'License and Maintainer' section in the readme.
|
|
120
|
-
|
|
121
|
-
|
|
119
|
+
will replace the last 'License and Maintainer' section in the readme. Under `Requirements`
|
|
120
|
+
section in readme file, `platform` and `cookbooks` are rendered from metadata.rb but if you need to place
|
|
121
|
+
anything else like environemnt or databags, you need to create `doc/requirements.md` which will
|
|
122
|
+
add the content to `Requirements` section. The remaining fragments will be included at the end
|
|
123
|
+
of the readme in lexicographic order of the filename.
|
|
122
124
|
|
|
123
125
|
## Installation
|
|
124
126
|
|
|
@@ -8,6 +8,10 @@
|
|
|
8
8
|
|
|
9
9
|
# Requirements
|
|
10
10
|
|
|
11
|
+
<% if fragments['requirements'] -%>
|
|
12
|
+
<%= fragments['requirements'] -%>
|
|
13
|
+
|
|
14
|
+
<% end -%>
|
|
11
15
|
## Platform:
|
|
12
16
|
|
|
13
17
|
<% unless platforms.empty? %>
|
|
@@ -144,7 +148,7 @@
|
|
|
144
148
|
|
|
145
149
|
<% end -%>
|
|
146
150
|
<% end -%>
|
|
147
|
-
<% fragments.keys.select {|k|k != 'overview' && k != 'credit'}.each do |key| -%>
|
|
151
|
+
<% fragments.keys.select {|k|k != 'overview' && k != 'credit' && k != 'requirements'}.each do |key| -%>
|
|
148
152
|
<%= fragments[key] %>
|
|
149
153
|
|
|
150
154
|
<% 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.20.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Mathias Lafeldt
|
|
@@ -9,7 +9,7 @@ authors:
|
|
|
9
9
|
autorequire:
|
|
10
10
|
bindir: bin
|
|
11
11
|
cert_chain: []
|
|
12
|
-
date: 2016-
|
|
12
|
+
date: 2016-03-11 00:00:00.000000000 Z
|
|
13
13
|
dependencies:
|
|
14
14
|
- !ruby/object:Gem::Dependency
|
|
15
15
|
name: chef
|