Reference Guides on Ansible, Puppet, and Chef (#331)

Merged PR #331.
GoogleCloudPlatform · Jul 10, 2018 · 1d19fb9 · 1d19fb9
1 parent 4b0efbd
commit 1d19fb9
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 3 deletions.
diff --git a/build/ansible b/build/ansible
diff --git a/build/chef/compute b/build/chef/compute
diff --git a/build/puppet/compute b/build/puppet/compute
diff --git a/templates/ansible/resource.erb b/templates/ansible/resource.erb
@@ -43,6 +43,15 @@ options:
 <%= lines(indent(doc_property_yaml(prop, object, 4), 4)) -%>
 <% end -%>
 extends_documentation_fragment: gcp
+<% if object.references -%>
+notes:
+<% if object.references.api -%>
+    - "API Reference: U(<%= object.references.api -%>)"
+<% end -%>
+<% object.references.guides.each do |guide, link| -%>
+    - "<%= guide -%>: U(<%= link -%>)"
+<% end # object.references -%>
+<% end # if object.references -%>
 '''
 
 <% if example -%>

diff --git a/templates/chef/README.md.erb b/templates/chef/README.md.erb
@@ -65,6 +65,15 @@ For complete details of the authentication cookbook, visit the
 ### <%= object.out_name -%>
 
 <%= object.description %>
+<% if object.references -%>
+#### Reference Guides
+<% if object.references.api -%>
+* [API Reference](<%= object.references.api -%>)
+<% end -%>
+<% object.references.guides.each do |guide, link| -%>
+* [<%= guide -%>](<%= link -%>)
+<% end # object.references.guides -%>
+<% end # if object.references -%>
 
 #### Example
 

diff --git a/templates/puppet/README.md.erb b/templates/puppet/README.md.erb
@@ -155,6 +155,15 @@ change by asserting it in the manifest.
 #### `<%= object.out_name -%>`
 
 <%= object.description %>
+<% if object.references -%>
+#### Reference Guides
+<% if object.references.api -%>
+* [API Reference](<%= object.references.api -%>)
+<% end -%>
+<% object.references.guides.each do |guide, link| -%>
+* [<%= guide -%>](<%= link -%>)
+<% end # object.references.guides -%>
+<% end # if object.references -%>
 
 #### Example
+4 −0		lib/ansible/modules/cloud/google/gcp_compute_address.py
+3 −0		lib/ansible/modules/cloud/google/gcp_compute_backend_bucket.py
+3 −0		lib/ansible/modules/cloud/google/gcp_compute_disk.py
+3 −0		lib/ansible/modules/cloud/google/gcp_compute_forwarding_rule.py
+3 −0		lib/ansible/modules/cloud/google/gcp_compute_global_address.py
+3 −0		lib/ansible/modules/cloud/google/gcp_compute_http_health_check.py
+3 −0		lib/ansible/modules/cloud/google/gcp_compute_https_health_check.py
+3 −0		lib/ansible/modules/cloud/google/gcp_compute_route.py
+3 −0		lib/ansible/modules/cloud/google/gcp_compute_ssl_policy.py
+4 −0		lib/ansible/modules/cloud/google/gcp_compute_subnetwork.py
+3 −0		lib/ansible/modules/cloud/google/gcp_compute_target_http_proxy.py
+3 −0		lib/ansible/modules/cloud/google/gcp_compute_target_https_proxy.py
+3 −0		lib/ansible/modules/cloud/google/gcp_compute_target_pool.py
+3 −0		lib/ansible/modules/cloud/google/gcp_compute_target_ssl_proxy.py
+3 −0		lib/ansible/modules/cloud/google/gcp_compute_target_tcp_proxy.py
+2 −0		lib/ansible/modules/cloud/google/gcp_compute_target_vpn_gateway.py