knife-cookbook-doc 0.24.0 → 0.24.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitattributes +11 -0
- data/CHANGELOG.md +4 -0
- data/README.md +4 -4
- data/lib/chef/knife/README.md.erb +2 -0
- data/lib/knife_cookbook_doc/version.rb +1 -1
- metadata +3 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 352a68b24110e8c990e327478345214b3b4e619d
|
4
|
+
data.tar.gz: 92555f89d0f0d0812eb76a04fa2b509714ea357d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0554d09c9f95fc917c6019166ae033901b01e50a3586f4c3f66686bd95aba34bf8cfd98234c2d8c282fae829ef7912ab369a81acabd327355fe4c82d89e2c420
|
7
|
+
data.tar.gz: 7941527cf37668835415a97e12ef35bd63b207b3db55ad8934ccddd0a202cc82ac7f839e5df9afaabbc94eb698237b6b232ab70e0522f236fc20cb99d8974ea3
|
data/.gitattributes
ADDED
data/CHANGELOG.md
CHANGED
data/README.md
CHANGED
@@ -22,7 +22,7 @@ it's currency.
|
|
22
22
|
#### Step 1
|
23
23
|
|
24
24
|
Populate the `metadata.rb` of your cookbook according to Opscode's
|
25
|
-
[documentation](
|
25
|
+
[documentation](https://docs.chef.io/config_rb_metadata.html). Particular
|
26
26
|
attention should be paid to documenting the platform compatibility and
|
27
27
|
cookbook requirements (i.e. depends, recommends, suggests etc). Documentation
|
28
28
|
for attributes and recipes can either be derived from scanning the source
|
@@ -116,10 +116,10 @@ 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. Under `Requirements`
|
119
|
+
will replace the last 'License and Maintainer' section in the readme. Under `Requirements`
|
120
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
|
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
123
|
of the readme in lexicographic order of the filename.
|
124
124
|
|
125
125
|
## Installation
|
@@ -156,9 +156,11 @@
|
|
156
156
|
# License and Maintainer
|
157
157
|
|
158
158
|
Maintainer:: <%= maintainer %> (<<%= maintainer_email %>>)
|
159
|
+
|
159
160
|
<% unless source_url.empty? -%>
|
160
161
|
<%= 'Source:: ' + source_url %>
|
161
162
|
<% end -%>
|
163
|
+
|
162
164
|
<% unless issues_url.empty? -%>
|
163
165
|
<%= 'Issues:: ' + issues_url %>
|
164
166
|
<% 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.24.
|
4
|
+
version: 0.24.1
|
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: 2017-
|
12
|
+
date: 2017-10-01 00:00:00.000000000 Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: chef
|
@@ -75,6 +75,7 @@ executables: []
|
|
75
75
|
extensions: []
|
76
76
|
extra_rdoc_files: []
|
77
77
|
files:
|
78
|
+
- ".gitattributes"
|
78
79
|
- ".gitignore"
|
79
80
|
- ".travis.yml"
|
80
81
|
- CHANGELOG.md
|