I thought chef cookbooks need a better documentation style than “write a README”, so I created the basis for one. I took yard-chef and rubydoc.info and after some hassle http://www.chefdoc.info was born. This is an early release, so don’t expect too much, but still, I hope you like it. And of course, it’s open source: https://github.com/chefdoc. The production service is running in a Docker container which is available at https://hub.docker.com/u/chefdoc/.
The most important aspect behind all this for me was to start with a very limited, and basic functionality and create documentation guidelines with the community. So apart from code contributions I also need input if a project like this makes sense at all and how it should progress.
- Support for private supermarkets and chef servers, so you can deploy chefdoc in your own infrastructure and have it document your cookbooks.
- Support for Definitions, LWRPs and custom resources.
- Cross linking within a cookbook, eg. link node attributes to where they are defined.
- Showing a dependency graph in some way.
- Display available metadata.
- Add cookbooks file and templates to docs and crosslink them inside the recipe source.
Notes about the service:
- I am currently hosting on sloppy.io, but they don’t offer sharing volumes between Docker containers which means I can not cache anything. So I will move to some other hosting service (probably Linode) in the future which should offer a major performance boost.
- Some cookbooks seem to not work at all. If you find one, please add it to the issue tracker: https://github.com/chefdoc/chefdoc.info/issues/1
Any kind of feedback, especially in form of pull requests is welcome.