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.

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

chore(website): Refactor Files to allow Source Markdown Link Scanning #5335

Merged
merged 4 commits into from
Feb 19, 2025

Conversation

X-Guardian
Copy link
Contributor

@X-Guardian X-Guardian commented Feb 16, 2025

what

Refactor the website markdown files to allow the website link check to be able to be run on the source files, rather than needing to run the scan on a website build.

Changes required:

  • Add missing .md extensions to internal markdown link references.
  • Move the blog images from the public folder to the relevant blog folder.
  • Update external code file references to use @include:

why

This will allows us to migrate from Muffet to Lychee for the Website Link Check.

Additional benefit is that images will now display correctly when previewing the markdown files in VSCode.

tests

@X-Guardian X-Guardian requested review from a team as code owners February 16, 2025 14:15
@X-Guardian X-Guardian requested review from chenrui333, lukemassa and nitrocode and removed request for a team February 16, 2025 14:15
@dosubot dosubot bot added refactoring Code refactoring that doesn't add additional functionality website labels Feb 16, 2025
@github-actions github-actions bot added docs Documentation blog labels Feb 16, 2025
Copy link
Member

@chenrui333 chenrui333 left a comment

Choose a reason for hiding this comment

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

lgtm

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Feb 19, 2025
@X-Guardian X-Guardian merged commit e98dc5f into runatlantis:main Feb 19, 2025
33 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blog docs Documentation lgtm This PR has been approved by a maintainer refactoring Code refactoring that doesn't add additional functionality website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants