Skip to content

Fix broken links - #443

Merged
ahouseholder merged 37 commits into
mainfrom
430-fix-links
Feb 15, 2024
Merged

ahouseholder merged 37 commits into
mainfrom
430-fix-links

Conversation

@ahouseholder

@ahouseholder ahouseholder commented Feb 7, 2024 •

Copy link
Copy Markdown
Contributor

This PR is an attempt to fix as many broken links as possible following the conversion from our PDF-oriented workflow to our mkdocs-oriented workflow.

Converting from one massive file to a website left us with a lot of section links (links to heading anchors like [Utility](#utility) that need to be replaced with links to files [Utility](../reference/decision_points/utility.md).

By a quick search of the markdown content, I think there were over 500 such links to start. I believe I've fixed them all here.

Output from the python linkchecker tool:

Statistics:
Downloaded: 5.43MB.
Content types: 6 image, 94 text, 0 video, 0 audio, 10 application, 2 mail and 250 other.
URL lengths: min=15, max=899, avg=84.

That's it. 362 links in 362 URLs checked. 0 warnings found. 0 errors found.
Stopped checking at 2024-02-14 12:07:05-004 (50 seconds)

Once merged, this PR puts us into a "known-good" ground state for link checking as well. I submitted a separate PR #465 as a downstream dependency on this one that will add a linkchecker acceptance test workflow for all future PRs.

Note Once approved, this PR should be squash merged rather than a normal merge due to the fact that the individual commits have almost no meaning as they're all intermediate work-in-progress fixes.

@ahouseholder ahouseholder added bug Something isn't working content/semantic Changes to the semantic content of the SSVC documentation labels Feb 7, 2024
@ahouseholder ahouseholder added this to the SSVC 202403 milestone Feb 7, 2024
@ahouseholder ahouseholder self-assigned this Feb 7, 2024
@ahouseholder ahouseholder linked an issue Feb 7, 2024 that may be closed by this pull request
@ahouseholder ahouseholder changed the title 430 fix links Fix #links from all-in-1 conversion Feb 8, 2024
# Conflicts:
#	docs/reference/decision_points/public_safety_impact.md
# Conflicts:
#	docs/about/changelog.md
# Conflicts:
#	docs/howto/communicating_results.md
#	docs/topics/credibility_indicators.md
#	docs/topics/index.md
#	mkdocs.yml
@ahouseholder ahouseholder changed the title Fix #links from all-in-1 conversion Fix broken links Feb 14, 2024
@ahouseholder
ahouseholder marked this pull request as ready for review February 14, 2024 17:18

@ahouseholder ahouseholder left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I was fixing links, I also took advantage of some opportunities to eliminate the need for some file includes by just merging the included content into the parent file. Hence there are a few file changes that look like they're adding content to files (which technically they are), but those are offset by removing the files that originally included that content.

Comment thread docs/howto/bootstrap/collect.md
Comment thread docs/howto/bootstrap/use.md
Comment thread docs/howto/communicating_results.md

@j--- j--- left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks so much for fixing all of these.

@ahouseholder
ahouseholder merged commit a8a8da9 into main Feb 15, 2024
@ahouseholder
ahouseholder deleted the 430-fix-links branch February 15, 2024 17:20
@ahouseholder ahouseholder modified the milestones: 2024.3, 1Q24 Jan 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working content/semantic Changes to the semantic content of the SSVC documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix the "#links" throughout

2 participants