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

Port docs from derby-site repo to this repo, with Jekyll on GH Pages hosting #625

Merged
merged 2 commits into from
Jan 17, 2024

Conversation

ericyhwang
Copy link
Contributor

The current Derby docs in the derby-site repo run as a custom Node server manually built and deployed with Docker. This makes doc updates a pain to do.

This PR ports the docs to a Jekyll-generated site, using the Just the Docs theme, built and deployed with GitHub Actions to GitHub Pages hosting.

In addition to being easier to maintain, the new docs also automatically support full-text doc search with autocompletion.

Notes:

  • I'd tried using the simple built-in GH Pages integration, but it's on the older Jekyll 2, which has always-on Liquid template processing that errors on the {{}} mustache-style syntax in the Derby code examples. Jekyll 3 has a config option to disable Liquid, but it requires a GitHub Action to do the build and deploy. Thankfully, there was a starter workflow to base it off of.
  • For now, the content's copied over from derby-site, with addition of Jekyll metadata in each Markdown file. I haven't done any editing, thorough checking for broken links, or theme customization. That can come in follow-ups once we have the basic setup working.

@ericyhwang ericyhwang requested a review from craigbeck January 12, 2024 23:06
Copy link
Contributor

@craigbeck craigbeck left a comment

Choose a reason for hiding this comment

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

👍

@ericyhwang ericyhwang merged commit d227027 into master Jan 17, 2024
3 checks passed
@ericyhwang ericyhwang deleted the docs branch January 17, 2024 21:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants