summaryrefslogtreecommitdiff
path: root/tasks
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* Remove some property deprecation logic from the generatorTim Smith2020-04-291-13/+9
| | | | | | We nuke these out of the list early on now Signed-off-by: Tim Smith <tsmith@chef.io>
* Skip documenting the deprecated propertiesTim Smith2020-04-291-1/+1
| | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* Skip the draft field in the docs generationTim Smith2020-04-291-1/+0
| | | | | | This defaults to false Signed-off-by: Tim Smith <tsmith@chef.io>
* Merge pull request #9751 from chef/lcg/chef-16-logging-fixedTim Smith2020-04-271-13/+5
|\ | | | | Rework logging to resolve STDOUT / log_location issues
| * Logging consistency fixes.lcg/chef-16-logging-fixedLamont Granquist2020-04-271-13/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - The doc formatter is now Chef::Config[:log_location]-aware and will log to files as well - There is now consistency where doc formatter output never surprisingly changes to log formatter based on destination - The "cli" log_location and the "config" log_location are now treated separately, so a log_location in the client.rb will always force output to a logfile, in addition to output to STDOUT if necessary - The logic around STDOUT is now simplified, if its open we log to it, if its closed we don't, if you're daemonized we assume you're capturing STDOUT via your process manager - The log_location variables are now Arrays Things not done: - The cli can't specify an array, it would be nice to support an accumulator pattern here. Would also need to support disabling STDOUT logging though. - Using the syslog or winevt logging devices requires the use of the logger, which precludes using the formatter. - Some people may want to have log-formatter style output to the log file and doc formatter style output to STDOUT which is not very possible right now. Right now we are consistent in that you get either the logger both places or the formatter both places. This use case is complicated by the fact that they will want :info level logging for the logger, but :warn level logging for the doc formatter and that is another global. - To do that latter thing right would probably require sending log messages to the formatter, and supporting a different log level in the formatter vs. the logger and then supporting the STDOUT/cli loggging being the formatter, while the log_location/config logging being the logger. Those were way out of scope for what I could get done for Chef-16. Signed-off-by: Lamont Granquist <lamont@scriptkiddie.org>
* | Don't add the weight to the yaml anymoreTim Smith2020-04-271-9/+0
| | | | | | | | | | | | It turns out if you don't add this they're just alphabetical which is what we were trying to do anyways. Signed-off-by: Tim Smith <tsmith@chef.io>
* | Chefstyle fixesTim Smith2020-04-271-31/+29
| | | | | | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* | Better handle the default valuesTim Smith2020-04-271-0/+10
| | | | | | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* | Print out strings not symbols and skip deprecated propertiesTim Smith2020-04-271-8/+13
| | | | | | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* | Update the skip listTim Smith2020-04-271-1/+1
| | | | | | | | | | | | | | scm is gone mac_user is new Signed-off-by: Tim Smith <tsmith@chef.io>
* | Start the weight at 70 to match the docs siteTim Smith2020-04-271-2/+2
| | | | | | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* | Make sure the description list is an arrayTim Smith2020-04-271-1/+1
| | | | | | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* | Enable the multipackage flag for more package managersTim Smith2020-04-271-1/+1
| | | | | | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* | Produce proper markdown in the example blockTim Smith2020-04-271-1/+0
| | | | | | | | | | | | The hugo code wraps this automatically Signed-off-by: Tim Smith <tsmith@chef.io>
* | Add "nil" to types list.Pete Higgins2020-04-271-1/+1
| | | | | | | | Signed-off-by: Pete Higgins <pete@peterhiggins.org>
* | Add code to handle properties only set in docs on a few resources.Pete Higgins2020-04-271-5/+97
| | | | | | | | Signed-off-by: Pete Higgins <pete@peterhiggins.org>
* | Update more things.Pete Higgins2020-04-271-20/+61
| | | | | | | | Signed-off-by: Pete Higgins <pete@peterhiggins.org>
* | Start the conversinon of moving to YAML generation for docsTim Smith2020-04-271-242/+54
|/ | | | | | | The .rst files are no more on the site. We now parse a yml file in hugo. Signed-off-by: Tim Smith <tsmith@chef.io> Signed-off-by: Pete Higgins <pete@peterhiggins.org>
* [FIX DEPRECATION] with_clean_env is deprecatedDan Webb2020-04-183-4/+4
| | | | | | | clean_env is now unbundled Signed-off-by: Daniel Webb <dan.webb@damacus.io>
* Remove copyright dateslcg/remove-copyright-datesLamont Granquist2020-04-133-3/+3
| | | | | | | | Legally incredibly dubious, particularly since we don't follow it strictly as policy, and we have git history instead, which does it right. This is just a waste of time and a cargo cult. Signed-off-by: Lamont Granquist <lamont@scriptkiddie.org>
* Turn off a lot of noise in test runs.Ryan Davis2020-03-161-0/+1
| | | | | | | | | | + I don't know how ---color was ever parsed to begin with. + -fd results in >23k lines of output that nobody reads. + This output obscures ~800 lines of output that everyone should read and silence. + Turned off verbose in rspec rake task. It's huge and doesn't help anything. Signed-off-by: Ryan Davis <zenspider@chef.io>
* Update docs for forking the stable branchTim Smith2020-02-031-1/+1
| | | | | | Make sure the external tests continue to work. Signed-off-by: Tim Smith <tsmith@chef.io>
* Chefstyle fixesTim Smith2019-11-151-1/+1
| | | | Signed-off-by: Tim Smith <tsmith@chef.io>
* Improve resource descriptions and the rake task for docs generationTim Smith2019-11-141-2/+10
| | | | | | Bring in a few more copy edits that were done on the website and improve the rake task so that it better creates docs that match the formatting we want. Signed-off-by: Tim Smith <tsmith@chef.io>
* Add chef-utils gem with various recipe DSL helpersLamont Granquist2019-11-081-6/+8
| | | | | | | | | | | | | This is the implementation of [RFC-087](https://github.com/chef-boneyard/chef-rfc/blob/master/rfc087-distro-sugar-helpers.md) although some of the specifics have been iterated on and changed. The documentation will be in the [README.md](https://github.com/chef/chef/tree/master/chef-utils/README.md) once this is merged. While this PR mostly moves chef-sugar utilities into core-chef via this chef-utils gem, the scope of the chef-utils gem should be considered larger than just that. As an example this PR moves the Mash class into this gem for reuse in ohai as well. Signed-off-by: Lamont Granquist <lamont@scriptkiddie.org>
* Add more resource examples to the codebaseTim Smith2019-09-161-1/+4
| | | | | | I'm also adding these same examples to the docs. Signed-off-by: Tim Smith <tsmith@chef.io>
* Fix Chef Client vs. Chef Infra Client logicTim Smith2019-08-081-1/+1
| | | | | | It helps to not pass a nil in Signed-off-by: Tim Smith <tsmith@chef.io>
* Improve the auto-generated docsTim Smith2019-08-081-10/+14
| | | | | | Formatting fixes and updates to the text to make the generated text match what's currently on the site. Signed-off-by: Tim Smith <tsmith@chef.io>
* Remove Travis / Jenkins config / docsTim Smith2019-07-311-1/+1
| | | | | | Update some of our build docs to reflect the current process. Nuke the old Travis config. We're Buildkite + appveyor only at this point. Signed-off-by: Tim Smith <tsmith@chef.io>
* Add examples to the resourcesTim Smith2019-07-081-0/+1
| | | | | | | | | Add examples in markdown to the resources. We'll be using this on the docs site in the future and if we need to display it we can use tty-markdown which does a really nice job of displaying markdown in the terminal Signed-off-by: Tim Smith <tsmith@chef.io>
* Merge pull request #8711 from chef/lcg/new-chefstyle2Lamont Granquist2019-07-082-5/+9
|\ | | | | More Chefstyle updates