summaryrefslogtreecommitdiff
path: root/tasks
Commit message (Collapse)AuthorAgeFilesLines
* Add support for resource action descriptions (#10986)Marc A. Paradise2021-02-041-7/+4
| | | Signed-off-by: Tim Smith <tsmith@chef.io>
* Update spellcheck task for new version of cspell.Pete Higgins2020-12-301-6/+1
| | | | Signed-off-by: Pete Higgins <pete@peterhiggins.org>
* Resolve build / test failures now that Chef 16 is the stable relase16_buildsTim Smith2020-12-181-1/+1
| | | | | | Point the new chef-16 branch at 16-stable ohai branch Signed-off-by: Tim Smith <tsmith@chef.io>
* Improve our automated resource documentation generationTim Smith2020-12-151-1/+1
| | | | | | Add more note values to the descriptions, update a few examples for cookstyle and modern gems, and identify a few more resources as providing package on their platform Signed-off-by: Tim Smith <tsmith@chef.io>
* Update the docs generation for the new formatTim Smith2020-11-191-18/+1
| | | | | | | The format has been simplified so we can remove some of the logic from our generation scripts. Signed-off-by: Tim Smith <tsmith@chef.io>
* Update the yaml we generate for resource documentationTim Smith2020-11-101-4/+1
| | | | | | | | We updated this in https://github.com/chef/chef-web-docs/commit/ec546e806366ca315b91e77eb357f65a14e11418 to simplify the yaml we have to generate. Signed-off-by: Tim Smith <tsmith@chef.io>
* Namespace ResourceInspector to avoid conflicts with Inspec's.Pete Higgins2020-11-021-1/+1
| | | | Signed-off-by: Pete Higgins <pete@peterhiggins.org>
* Don't add a package warning for solaris_packageTim Smith2020-10-281-1/+1
| | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* Correctly generate docs yaml files to include package warningsTim Smith2020-10-281-5/+5
| | | | | | This data actually needed to be under resource_description_list and not at the top level. Signed-off-by: Tim Smith <tsmith@chef.io>
* Make sure we set both multipackage configs in the docsdocs_generation_updatesTim Smith2020-10-281-3/+4
| | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* Improve the package docs generation + resolve rubocop warningsTim Smith2020-10-281-5/+5
| | | | | | Resolve a few valid warnings there and then add a few more resources where we should be showing package warnings. Signed-off-by: Tim Smith <tsmith@chef.io>
* Remove the announcement rake task + minor task updatesTim Smith2020-10-204-87/+2
| | | | | | | | | - The rake task to generate the announcement no longer works because our release notes file contains all the release notes. We're going to need some automation in the future for this, but this isn't it. - Convert the docs task from .to_yml to YAML.dump - Improve the component rake task description - Nuke another copyright data range Signed-off-by: Tim Smith <tsmith@chef.io>
* Update docs generation task to handle Chef 16 required formatTim Smith2020-10-161-1/+1
| | | | | | | We need a boolean for the docs site here, but we get back an array now. For now let's just treat it like a boolean. Signed-off-by: Tim Smith <tsmith@chef.io>
* Avoid declaring arrays in loopsTim Smith2020-10-161-1/+3
| | | | | | There's still a few of these left over, but these are the easy wins with obvious wins. Signed-off-by: Tim Smith <tsmith@chef.io>
* Stop using the Ohai shortcodeTim Smith2020-09-151-7/+1
| | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* Update tasks/rspec.rbTim Smith2020-09-091-2/+0
| | | Co-authored-by: pete higgins <pete@peterhiggins.org>
* Use __dir__ instead of getting the dir of __FILE__Tim Smith2020-09-093-3/+3
| | | | | | This is a bit easier to read Signed-off-by: Tim Smith <tsmith@chef.io>
* Fix spellcheck task on Windows.fix-spellcheck-task-on-windowsPete Higgins2020-08-241-2/+7
| | | | Signed-off-by: Pete Higgins <pete@peterhiggins.org>
* Don't depend on chef-utils when it might not be available.update-spellcheck-setupPete Higgins2020-08-051-2/+2
| | | | Signed-off-by: Pete Higgins <pete@peterhiggins.org>
* Fix chefstyle violations.Pete Higgins2020-08-051-2/+2
| | | | Signed-off-by: Pete Higgins <pete@peterhiggins.org>
* Update spellcheck config with nice stuff from other repos.Pete Higgins2020-08-051-6/+16
| | | | Signed-off-by: Pete Higgins <pete@peterhiggins.org>
* Speed up our bundle installs by always running 3 jobsfaster_bundler_installsTim Smith2020-08-042-2/+2
| | | | | | | multi-job bundle install is the default in the next release, but for now we should make sure we set it everywhere. Signed-off-by: Tim Smith <tsmith@chef.io>
* Minor chefstyle fixes in the spellcheck taskTim Smith2020-07-101-4/+4
| | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* Refer to specific rake file to avoid needing bundler to use rake in CI.Pete Higgins2020-07-101-3/+17
| | | | Signed-off-by: Pete Higgins <pete@peterhiggins.org>
* Refactor spellcheck task and stick it in its own taskTim Smith2020-06-231-0/+34
| | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* Fix cookstyle violations.Pete Higgins2020-06-221-3/+3
| | | | Signed-off-by: Pete Higgins <pete@peterhiggins.org>
* Make the description parsing in docs rake task handle more stuff.Pete Higgins2020-06-221-20/+33
| | | | Signed-off-by: Pete Higgins <pete@peterhiggins.org>
* Add more resource docs + improve yaml generationresource_docsTim Smith2020-06-051-1/+1
| | | | | | Skip defaults that are empty strings. There's a few of these floating around. Signed-off-by: Tim Smith <tsmith@chef.io>
* Improve auto-generated docsTim Smith2020-05-281-1/+1
| | | | | | | | Add more descriptions and examples Remove some smart quotes Make sure homebrew_package gets tagged as supporting multi-package Signed-off-by: Tim Smith <tsmith@chef.io>
* Fix a typo.Pete Higgins2020-05-181-1/+1
| | | | Signed-off-by: Pete Higgins <pete@peterhiggins.org>
* Pin chef-telementry to 1.0.3 to avoid ffi build breakageTim Smith2020-05-051-3/+1
| | | | | | | | | | The latest chef-telemetry gem brings in http 4 which brings in a pile off FFI gems that break the builds. Pin until the http dep is removed from the telemtry gem https://github.com/chef/chef-telemetry/issues/32. This also speeds up how to bundle our gems to match what the Workstation team did to speed up the job. Signed-off-by: Tim Smith <tsmith@chef.io>
* Split the descriptions and notes outTim Smith2020-05-011-8/+12
| | | | | | This fixes a few resources that included notes Signed-off-by: Tim Smith <tsmith@chef.io>
* We don't use the resource name bolding functionality anymoreTim Smith2020-05-011-14/+0
| | | | | | We just bold the text in the description ourselves. It's way more reliable. Signed-off-by: Tim Smith <tsmith@chef.io>
* Skip nil values in the type listTim Smith2020-05-011-4/+6
| | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* Bump the ignored default length to 45Tim Smith2020-05-011-1/+1
| | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* Don't put very long descriptions in the block exampleTim Smith2020-05-011-1/+3
| | | | | | They'll wrap Signed-off-by: Tim Smith <tsmith@chef.io>
* Don't write out false values for configs in the resource yamlTim Smith2020-05-011-34/+30
| | | | | | The values default to false so only write out the true values, which makes it much easier to see what we're actually trying to set. This also means the yaml files won't wall change if we add a new config, which we will. Signed-off-by: Tim Smith <tsmith@chef.io>
* Skip syntax_shortcode entirely unless we're in a log resourceTim Smith2020-05-011-4/+1
| | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* Remove some nils that come for freeTim Smith2020-05-011-4/+0
| | | | | | Thanks Ruby! Signed-off-by: Tim Smith <tsmith@chef.io>
* Chefstyle fixesTim Smith2020-05-011-2/+2
| | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* Handle the scenario where there are no properties betterTim Smith2020-05-011-3/+7
| | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* Remove some special content for breakpointTim Smith2020-05-011-6/+1
| | | | | | We autogenerate better content that these snippets Signed-off-by: Tim Smith <tsmith@chef.io>
* Handle symbols in the equal_to valuesTim Smith2020-05-011-1/+1
| | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* Docs generation: Add examples & simplify actionsTim Smith2020-04-301-8/+3
| | | | | | Add the new docs field and skip the special casing of nothing since the hugo template actually handles that. Signed-off-by: Tim Smith <tsmith@chef.io>
* Sort the list of actions when generating docsTim Smith2020-04-291-1/+1
| | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* Add a skeleton values for actions / examplesTim Smith2020-04-291-0/+22
| | | | | | We need to extend the data we present via chef and also change the hugo template for the examples, but for now this makes the diff much easier. Signed-off-by: Tim Smith <tsmith@chef.io>
* Comment why we append --- in the docs generatorTim Smith2020-04-291-0/+2
| | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* Make sure our yaml blocks end with ---Tim Smith2020-04-291-1/+1
| | | | | | The files aren't actually yaml. They're markdown with yaml blocks so we need to end them. Signed-off-by: Tim Smith <tsmith@chef.io>
* Tweak resource formattingTim Smith2020-04-291-1/+1
| | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* Updates to the code generation taskTim Smith2020-04-291-13/+13
| | | | | | | | | Don't generate the nil robots or syntax_code_block fields Skip empty fields in our properties Confirmed with Ian that Hugo is going to skip the empty fields anyways Signed-off-by: Tim Smith <tsmith@chef.io>