Add Docs Check to Pull Request CI #692
Labels
kind/cleanup
Categorizes issue or PR as related to cleaning up code, process, or technical debt.
kind/documentation
Categorizes issue or PR as related to documentation.
Milestone
Issue
The community has decided to keep reference documentation in the same tree as code to facilitate high quality contributions.
To publish this documentation, the website repo will utilize a sync script that copy docs markdown from the code repositories to the website repo, which then generates the static HTML.
In order for the website to render correctly, "front matter" metadata needs to be embedded in the markdown stored in code repositories.
Proposed Solution
Add a "docs" GitHub action in shipwright-io/build (and future repositories) which checks out the website code, runs the sync, and then has hugo generate the static content.
Failures here will need to have clear messaging so contributors know what went wrong and how to fix it.
Hopefully we will catch 90% of bugs that would cause the Netlify deployment to fail from synced content.
Notes
Depends on shipwright-io/website#29
Originally posted by @adambkaplan in shipwright-io/website#27 (comment)
The text was updated successfully, but these errors were encountered: