rightscale-cookbooks / yard-chef Goto Github PK

Hi,

Awesome project, thank for doing this.
It seems that your code uses YARD::DocstringParser which is not available in yard 0.7 (as indicated in the Gemfile) but is there in the latest release (I didn't test other 0.8.x release). I suggest that you update the dependency requirement.

Also, any change of releasing the gem on rubygems.org? That would be great!

I see mention of attribute handling in this project but I see no examples of how to use it. Can yard-chef generate documentation of attributes somehow or am I reading to much into the source ?

Hi Team,
Thanks for fantastic library. My requirement is - I want to show cookbook's LWRP documentation. Is there any way to show this. Here is the code from my recipe-

#Install 'splunkforwarder' package
package 'splunkforwarder' do
  version node['sap-splunk-client']['version']
  action :install
  not_if { File.exist?("#{node['sap-splunk-client']['splunk_home']}/splunk-#{node['sap-splunk-client']['version']}-x86_64-manifest") }
end

I am expecting something to show under resource-

Can you please help me??

Any particular reason Redcarpet is locked at version 2?

In README.md,

YARD::Config.load_plugins 'chef'

should really say

YARD::Config.load_plugin 'chef'

Cheers
Stephan

Currently the plugin treats a repository as the root level object. For those of us that publish public cookbooks or have a workflow heavily informed by Berkshelf it would be nice to be able to treat our cookbook as the root of the documentation.

We don't generate documentation for an entire Gemfile, just for the gem we are developing. I think we should at least support the option for the same behavior.

LWRP names seem to be generated automatically using <coobkook_name>_<resource_name> which is correct for definitions, but not necessarily for LWRPs. According to the chef docs a "provides" can be defined, which specifies the LWRPs name (https://docs.chef.io/lwrp_custom_resource.html#provides).

How would we document dynamic attributes? Previously, we had all attributes documented in metadata.rb which gave us maximum control over how the attributes are documented. But this is deprecated in Chef 13 and will be removed in Chef 14 according to the Chef documentation.
We have a lot of cookbooks where attributes are defined in run-time according to architecture, network zone an so on where it seems not to be feasible to generate a documentation from the attributes file (see an example here).
Is there another way to store the attribute definitions?

N.b. If you use the explicit attribute notation node.level yard-chef just ignores them.

I'm relatively new to yard, and yard-chef, so please forgive me if this is a stupid question.

I understand that the brief description for the recipse comes from the metadata.rb file. I've got this working, but I wonder whether there is a way to also get a more detailed description, which would be documented within the recipe file probably at the top of the file.

Is this somehow possible?

I am facing an issue where attributes are not getting parsed properly. I don't see description, default values etc.
I am not too sure if the plugin is getting loaded properly.
Tried with ruby 4.6.0 and 4.3.1

Ran: yardoc './**/*.rb' --plugin chef --verbose

Following is what I see in UI: (missing description and default values)

Thanks in advance for the help.