[BUG] Resources who's default action is :nothing don't indicate the default in the documentation
gene1wood opened this issue · 1 comments
General details
Because the :nothing action is represented with a shortcode instead of markdown in the resource data .yaml files, resources which have a default action of :nothing don't indicate what the default action is in the documentation.
This affects these files
data/infra/resources/selinux_state.yamldata/infra/resources/service.yamldata/infra/resources/systemd_unit.yamldata/infra/resources/notify_group.yamldata/infra/resources/reboot.yaml
As an example, the service resource uses the shortcode for the :nothing action
as a result the doc page for the service resource shows 7 actions and none of them indicate that they are the default (with a (default) in the description as is the standard).
I'm unsure how best to fix this. If someone wants to suggest how to go about it, I'm happy to submit a PR.
Is there a way to combine a shortcode with raw markdown? Or can this readfile Shortcode behavior be used in the resource yaml files?
Product
- Chef Automate
- Chef Habitat
- Chef Infra Client
- Chef Infra Server
- Chef InSpec
- Other________________
Describe the update that needs to be made. Be as specific as possible:
Some change needs to be made so that these 5 resources can indicate in the documentation that the :nothing action is the default.