search

chef / chef-web-docs

All The Documentation
https://docs.chef.io
Other
132 stars 435 forks source link

(ChefDK) Policyfile doc redundancy #30

Closed edehde closed 8 years ago

edehde commented 8 years ago

While the About Policyfile page at https://docs.chef.io/policy.html seems to cover the latest implementation, the Policyfile.rb page at https://docs.chef.io/config_rb_policyfile.html is currently rather incomplete and thus misleading (unfortunately the first result in https://docs.chef.io/search.html?q=Policyfile).

Would be helpful to add a link to the "About Policyfile" doc page at the recently updated https://github.com/chef/chef-dk/blob/master/POLICYFILE_README.md since this is still the main "landing page" (https://www.google.de/search?q=chefdk%20policyfile)

jamescott commented 8 years ago

https://docs.chef.io/policyfile.html is the new topic. The config_rb_policyfile.html topic is about only the config file, but now has a link to policyfile.html. The policy.html topic is reset to be a proper overview to the various policy options (it's not actually hooked in anywhere, but exists in case folks find it via search); policyfile.html is the one hooked in from the left-side navigation. We're going to deprecate most of the words in the POLICYFILE_README.md file now, and point to the chef-docs page.

You caught us right in the middle of making this change :) Hopefully this is helpful.

james

edehde commented 8 years ago

Danke @jamescott this will be helpful indeed for evangelizing the Chef Policy workflow in the future :)