Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 1 commit into from
Aug 25, 2023
Merged

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

merged 1 commit into from
Aug 25, 2023

Conversation

IanMadd
Copy link
Contributor

@IanMadd IanMadd commented Aug 15, 2023 •
edited
Loading

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.

@IanMadd
CHEF-5468 Correct heading level in output docs yaml files
2fb915b 
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
@IanMadd IanMadd added the Aspect: Documentation How do we use this project? label Aug 15, 2023
@IanMadd IanMadd requested review from a team as code owners August 15, 2023 15:53
@sonarcloud
Copy link

sonarcloud bot commented Aug 15, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@vkarve-chef vkarve-chef added the Expeditor: Skip All Used to skip all merge_actions. label Aug 25, 2023
@vkarve-chef vkarve-chef merged commit 2971520 into main Aug 25, 2023
10 checks passed
@vkarve-chef vkarve-chef deleted the im/docs_rake_task branch August 25, 2023 05:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vkarve-chef vkarve-chef vkarve-chef approved these changes

Assignees
No one assigned
Labels
Aspect: Documentation How do we use this project? Expeditor: Skip All Used to skip all merge_actions.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@IanMadd @vkarve-chef