Skip to content

Chore: Fix Value issue

Ashvith requested to merge gitlab-community/gitlab:387420-fix-vale-issues-for-security/crime_vulnerability.md into master

What does this MR do and why?

Addresses documentation issues in security/crime_vulnerability.md.

Screenshots or screen recordings

Before correction

 
vale doc/security/crime_vulnerability.md

 doc/security/crime_vulnerability.md
 1:1    suggestion  The grade level is 12.79.       gitlab.ReadingLevel   
                    Aim for 8th grade or lower by                         
                    using shorter sentences and                           
                    words.                                                
 12:23  suggestion  Improve readability by using    gitlab.SentenceLength 
                    fewer than 25 words in this                           
                    sentence.                                             
 29:1   suggestion  Improve readability by using    gitlab.SentenceLength 
                    fewer than 25 words in this                           
                    sentence.                                             
 30:48  warning     Check the spelling of           gitlab.Spelling       
                    'NGINX's'. If the spelling                            
                    is correct, ask a Technical                           
                    Writer to add this word to the                        
                    spelling exception list.                              
 53:42  suggestion  Remove the phrase 'note that'.  gitlab.Wordy          

✖ 0 errors, 1 warning and 4 suggestions in 1 file.

After correction

 
vale doc/security/crime_vulnerability.md

 doc/security/crime_vulnerability.md
 1:1    suggestion  The grade level is 12.82.       gitlab.ReadingLevel   
                    Aim for 8th grade or lower by                         
                    using shorter sentences and                           
                    words.                                                
 12:23  suggestion  Improve readability by using    gitlab.SentenceLength 
                    fewer than 25 words in this                           
                    sentence.                                             
 29:1   suggestion  Improve readability by using    gitlab.SentenceLength 
                    fewer than 25 words in this                           
                    sentence.                                             

✔ 0 errors, 0 warnings and 3 suggestions in 1 file.

How to set up and validate locally

Run vale doc/security/crime_vulnerability.md

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

/cc @kpaizee

Related to #387420 (closed)

Merge request reports