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

update marlinfw.org ruby and jekyll #579

Merged
merged 6 commits into from
Sep 12, 2024

Conversation

ellensp
Copy link
Contributor

@ellensp ellensp commented Aug 19, 2024

Update marlinfw.org to comply with Github pages dependency versions https://pages.github.com/versions/

I've tested this on local linux machine, it looks complete, but needs checking by someone familiar with every facet.. I haven't tested .github/workflows/jekyll-pub.yml

There are new docs coming from thisiskeithb on how to install locally for all the OS's

My notes: Install Ruby 3.3.4 on Ubuntu

I Installed https://github.com/rbenv/rbenv as the os version is not recent, mostly following https://shape.host/resources/step-by-step-guide-installing-ruby-on-rails-with-rbenv-on-ubuntu-22-04

Enter these commands

  sudo apt update
  sudo apt install git curl libssl-dev libreadline-dev zlib1g-dev autoconf bison build-essential libyaml-dev libreadline-dev libncurses5-dev libffi-dev libgdbm-dev
  curl -fsSL https://github.com/rbenv/rbenv-installer/raw/HEAD/bin/rbenv-installer | bash

  echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc
  echo 'eval "$(rbenv init -)"' >> ~/.bashrc

  source ~/.bashrc

  rbenv install 3.3.4
  rbenv global 3.3.4
  ruby -v

  echo '# Install Ruby Gems to ~/gems' >> ~/.bashrc
  echo 'export GEM_HOME="$HOME/gems"' >> ~/.bashrc
  echo 'export PATH="$HOME/gems/bin:$PATH"' >> ~/.bashrc
  source ~/.bashrc

  gem install bundler

Get MarlinDocumentation with updated files from this PR

change into MarlinDocumentation directory and enter these commands

  bundle config set path 'vendor/bundle'
  bundle install
  bundle exec jekyll -v
  bundle exec jekyll serve --watch --incremental

@thisiskeithb
Copy link
Member

thisiskeithb commented Aug 19, 2024

I've confirmed that everything builds in clean installs of Ubuntu 24.04 LTS, Windows 10, and macOS Monterey 12.7.6 (limited by my hardware).

I've updated my "Overhaul README" PR, so it's now tied to these updates:

@thisiskeithb
Copy link
Member

One minor suggestion: Add a .ruby-version file in the project root with 3.3.4 in it so the Ruby version is switched automatically for those that have configured their system to do so.

@ellensp
Copy link
Contributor Author

ellensp commented Aug 20, 2024

I was thinking more add it to .gitignore, then users can play with other version in the future without fighting

instructions Outdated Show resolved Hide resolved
@thinkyhead thinkyhead merged commit 5295952 into MarlinFirmware:master Sep 12, 2024
1 check passed
@ellensp ellensp deleted the test-update branch September 13, 2024 14:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants