ruby-lsp icon indicating copy to clipboard operation
ruby-lsp copied to clipboard

Use Netlify to build documentation preview for PRs

Open st0012 opened this issue 1 year ago • 1 comments

Motivation

Currently, to review a documentation change, one needs to:

  1. Pull the change and checkout to it with gh command
  2. Run cd jekyll
  3. Run bundle exec jekyll serve

And it's assuming that Jekyll is already installed to the latest version locally.

If we can have a way to preview the doc changes directly, it'd be much easier for maintainers and anyone who's interested in the changes to review. And hopefully lowering the reviewing costs can also make doc contribution (feel) easier.

Implementation

  1. Use Ruby 3.3.3 for jekyll folder. I explained more in the comments below.
  2. Add netlify.toml to store all build configurations.

With the build ignore config in place, Netlify's free plan should cover our current usages.

Automated Tests

Manual Tests

st0012 avatar Oct 01 '24 16:10 st0012

Deploy Preview for ruby-lsp ready!

Name Link
Latest commit ba4b2b0161c0e4d21b16843fbf044b9c277eb8a2
Latest deploy log https://app.netlify.com/sites/ruby-lsp/deploys/66fc577306886c0008babe78
Deploy Preview https://deploy-preview-2646--ruby-lsp.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Oct 01 '24 16:10 netlify[bot]

This pull request is being marked as stale because there was no activity in the last 2 months

github-actions[bot] avatar Dec 01 '24 12:12 github-actions[bot]

Since Netlify's usage at Shopify is still not approved, I'm closing this now.

st0012 avatar Dec 02 '24 12:12 st0012