CHEF-5468 Correct heading level in output docs yaml files - Githubissues

chef / cookstyle

A linting tool that helps you to write better Chef Infra cookbooks and InSpec profiles by detecting and automatically correcting style, syntax, and logic mistakes in your code.

Apache License 2.0

109 stars 54 forks source link

CHEF-5468 Correct heading level in output docs yaml files #962

Closed IanMadd closed 1 year ago

IanMadd commented 1 year ago

Correct the heading levels in examples in the output yaml files for documentation.

Description

Currently the YAML files output from the generate_cops_yml_documentation rake task have H4 headings in the correct and incorrect example headings (for example https://docs.chef.io/workstation/cookstyle/chef_correctness_blockguardwithonlystring/#examples), but they should be H3. This changes them from H4 --> H3.

update the heading levels in the cop ruby files
update the rake task
update the output yaml files

Related Issue

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
[ ] Chore (non-breaking change that does not add functionality or fix an issue)

Checklist:

[ ] I have read the CONTRIBUTING document.
[ ] I have run the pre-merge tests locally and they pass.
[ ] I have updated the documentation accordingly.
[ ] I have added tests to cover my changes.
[ ] All new and existing tests passed.
[ ] All commits have been signed-off for the Developer Certificate of Origin.

sonarcloud[bot] commented 1 year ago

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication