Skip to content

Validate mkdocs#537

Merged
fyliu merged 2 commits intohackforla:mainfrom
fyliu:536-validate-mkdocs
Sep 19, 2025
Merged

Validate mkdocs#537
fyliu merged 2 commits intohackforla:mainfrom
fyliu:536-validate-mkdocs

Conversation

@fyliu
Copy link
Copy Markdown
Member

@fyliu fyliu commented Sep 8, 2025

Fixes #536

What changes did you make?

  • configured mkdocs validation for maximum strictness
  • added script to validate mkdocs
  • checked in fix for validation warning
  • added GHA workflow to validate mkdocs
  • added documentation for the GHA

Why did you make the changes (we will use this info to test)?

  • we need the validation to check the mkdocs build to make sure the mkdocs site deployment works and is free of basic issues like broken internal links

Testing

  1. validate-mkdocs.sh - Just run it to test. Maybe re-introduce the validation issue that's been fixed.

  2. GHA workflow - use act to test.

    1. Install act.

    2. Run workflow by file.

      act -W '.github/workflows/pull-request.yml'
    3. Can introduce the validation issue to see it fail.

@fyliu
Copy link
Copy Markdown
Member Author

fyliu commented Sep 8, 2025

I borrowed the workflow from the docker-mkdocs project and it failed because we don't install mkdocs in our project. I'll see if I can make use of the docker image from there.

@fyliu fyliu force-pushed the 536-validate-mkdocs branch from 9b5c003 to 782e1df Compare September 8, 2025 04:17
@fyliu
Copy link
Copy Markdown
Member Author

fyliu commented Sep 8, 2025

I modified the GHA to use the image from hackforlaops/mkdocs:latest. /dev/null -> /tmp because GHA doesn't like /dev/null

@fyliu fyliu marked this pull request as ready for review September 8, 2025 04:37
@fyliu fyliu moved this to PR Needs review (automated column, do not place items here manually) in P: PD: Project Board Sep 9, 2025
@fyliu fyliu self-assigned this Sep 9, 2025
@fyliu fyliu force-pushed the 536-validate-mkdocs branch from 782e1df to 10a0410 Compare September 10, 2025 17:50
@fyliu fyliu force-pushed the 536-validate-mkdocs branch 2 times, most recently from a5de37a to c307007 Compare September 16, 2025 04:31
@del9ra del9ra self-requested a review September 17, 2025 23:56
Copy link
Copy Markdown
Member

@del9ra del9ra left a comment

Choose a reason for hiding this comment

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

Thanks for contributing, Fang! I tested your code on my PC and it works perfectly.

@fyliu fyliu force-pushed the 536-validate-mkdocs branch from c307007 to a004921 Compare September 19, 2025 04:01
@fyliu fyliu merged commit b666402 into hackforla:main Sep 19, 2025
2 checks passed
@github-project-automation github-project-automation bot moved this from PR Needs review (automated column, do not place items here manually) to ✅Done in P: PD: Project Board Sep 19, 2025
@fyliu fyliu deleted the 536-validate-mkdocs branch November 9, 2025 02:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ✅Done

Development

Successfully merging this pull request may close these issues.

Validate mkdocs

2 participants