Set correct source directory for jekyll gh-pages action#122
Set correct source directory for jekyll gh-pages action#122gavindidrichsen wants to merge 1 commit intomainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #122 +/- ##
=======================================
Coverage 86.80% 86.80%
=======================================
Files 35 35
Lines 2092 2092
=======================================
Hits 1816 1816
Misses 276 276 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
ekohl
left a comment
There was a problem hiding this comment.
I don't think I have merge permissions here, but I'd urge you to make the git commit summary more concrete. For example, Set correct source directory for jekyll gh-pages action is clearer. Especially when you go through an old project it's better than having 10 "fix jekyll gh-pages action" commits because 10 different things were broken over the years.
The default jekyll gh-pages action "sources" its documentation from the root "/" of the repository; however, the `rspec-puppet` has its documentation root beneath "/docs/". In other words, the "/docs/" directory contains more advanced jekyll configuration like a "/docs/_config.yml" and a "/docs/_includes/" directory. This PR fixes the gh-pages deployment. See https://puppetlabs.github.io/rspec-puppet/ for latest documentation Signed-off-by: Gavin Didrichsen <gavin.didrichsen@gmail.com>
f08ce63 to
0517a5b
Compare
|
@jordanbreen28 : Thanks for spotting the broken links. I'm investigating now so moving this back to draft. |
Summary
The default jekyll gh-pages action "sources" its documentation from the root "/" of the repository; however, the
rspec-puppethas its documentation root beneath "/docs/". In other words, the "/docs/" directory contains more advanced jekyll configuration like a "/docs/_config.yml" and a "/docs/_includes/" directory. This PR fixes the gh-pages deployment.See https://puppetlabs.github.io/rspec-puppet/ for latest documentation
Related Issues (if any)
Mention any related issues or pull requests.
Checklist