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

Migration to JBake #15

Merged
merged 10 commits into from
Jan 28, 2024
Merged

Migration to JBake #15

merged 10 commits into from
Jan 28, 2024

Conversation

tarilabs
Copy link
Member

@tarilabs tarilabs commented Jan 9, 2024

Context and Problem statement

jugmilano.it is a static website, currently generated with Jekyll and customized templates.
Sometimes, modifications/contributions are needed from folks not familiar with Ruby/Jekyll.
Faced challenges:

  • quick corrections of the YAML remotely via smartphone was challenging while on holiday 🏖️ 🍹
  • folks mentioned is sometimes difficult to install Ruby/chruby/jekyll just to test locally
  • folks mentioned is sometimes tedius to spin a docker container just to test locally

This proposed changes migrates FROM Jekyll TO JBake.

  • JBake is Java/JVM based analogous of Jekyll
  • Build is automated using Maven (another familiar build tool for JVM devs)

Goals

  • Migrate from Jekyll by avoiding as much as possible modification to content files.
    • achieved by customizing markdown engine processing .md files' front-matter (ref)
  • Preserve as much git history as possible
    • except of few files, content was rearranged preserving attribution and git history
  • Instrument website build via Maven
  • CI/CD for publishing on GH Pages via GHA
  • Quick utility for "previewing" and testing the website locally

Non-goals

  • Additional CI/CD or infra changes (can be addressed in subsequent PR/changes)
  • Modification to layout/styles/pages (can be addressed in subsequent PR/changes)

Testing these changes

Checkout this PR and follow 2 commands in README.md.

@lucamolteni lucamolteni self-requested a review January 9, 2024 21:37
Copy link
Contributor

@lucamolteni lucamolteni left a comment

Choose a reason for hiding this comment

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

OMG thanks

_posts/faq.md Outdated Show resolved Hide resolved
@tarilabs tarilabs merged commit 3e89162 into master Jan 28, 2024
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.

3 participants