fix: the SAST tool checklist in the security guide loses its first two items - #3754
Open
Parhamfakhar1 wants to merge 1 commit into
Open
Parhamfakhar1 wants to merge 1 commit into
Parhamfakhar1 wants to merge 1 commit into
Conversation
In the security best practices guide, the checklist under "How to choose your
SAST tool?" starts two sentences short:
How to choose your SAST tool?
Check the license: Some tools are free for open source projects. ...
Check the coverage for your language(s)
* Select one that easily integrates with the tools you already use...
Because there is no blank line and no list marker, kramdown emits all three
lines inside a single <p>, so the browser collapses them into one run-on
sentence and the list below starts with "Select one ..." — the reader loses
the first two criteria. This is visible on the live page:
https://opensource.guide/security-best-practices-for-your-project/
The English file has had this since the article's first draft (8136cb8), so
24 translations copied the same broken shape, while fa, hi and tr already
render these two lines as list items. Making them proper list items in the
source matches what the majority of the article already does and brings the
English in line with those three translations.
No wording was changed. `node test/prose` reports no issues.
2 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Please note: we will close your PR without comment if you do not check the boxes above and provide ALL requested information.
In
_articles/security-best-practices-for-your-project.mdthe checklist under"How to choose your SAST tool?" starts two criteria short:
The first three lines have no blank line and no list marker, so kramdown puts them
in one
<p>and the browser collapses them into a run-on sentence, while the listbelow starts mid-way. Live:
https://opensource.guide/security-best-practices-for-your-project/ —
<p>How to choose your SAST tool? Check the license: … Check the coverage for your language(s)</p>followed by a 3-item<ul>.Making the two criteria list items keeps the list intact and matches the shape that
fa,hiandtralready use — those three translations fixed it per-language. Ichecked all 29 copies of this article: 22 of them (English plus 21 translations)
collapse the lead-in and the two criteria into one paragraph, 3 render five list
items with zero unmarked lines, and 4 (
ar,ja,sa,zh-hans) phrase thelead-in so differently that I did not count them either way. The marker has been missing since the article's first draft (8136cb8,
"First draft of Security article"), which is why it spread to so many copies. If you
want, I can push a second commit that repairs the marker in every translation,
touching nothing but the list markers.
No wording changed;
node test/prosereports no issues.