📖 docs: fix broken markdown links and a typo - #5158
Open
LD-RW wants to merge 1 commit into
Open
Conversation
The Scorecard link in scalable_scorecard.md and the yamllint link in cron/k8s/README.md both omit the URL scheme, so GitHub renders them as repository-relative paths that 404. The Scorecard link also misspells the org as 'oosf'. Also corrects 'alloted' to 'allotted' in SECURITY.md. Signed-off-by: LD-RW <basheermazari4@gmail.com>
dosubot
Bot
added
the
size:XS
📄 Knowledge reviewDosu skipped reviewing this PR because your organization has used its
|
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.
What kind of change does this PR introduce?
A docs fix — two broken markdown links and one spelling correction.
What is the current behavior?
Two markdown links omit the URL scheme, so GitHub resolves them as repository-relative paths and they 404:
docs/design/scalable_scorecard.md:[Scorecard](github.com/oosf/scorecard)renders as/ossf/scorecard/blob/main/docs/design/github.com/oosf/scorecard. The org is also misspelled (oosfinstead ofossf).cron/k8s/README.md:[yamllint](yamllint.readthedocs.io)renders as/ossf/scorecard/blob/main/cron/k8s/yamllint.readthedocs.io.Separately,
SECURITY.mduses "alloted" where "allotted" is intended.What is the new behavior (if this is a feature change)?
Both links now use absolute
https://URLs and resolve correctly, and the spelling is corrected. No code or behavior changes.Which issue(s) this PR fixes
NONE
Special notes for your reviewer
Documentation only; no Go files touched. Each rendered URL was verified against the live rendering on
mainbefore the change.Does this PR introduce a user-facing change?