search

ably / engineering

Ably's new home for engineering guidance, including content previously served from Confluence at engineering.ably.com.
https://engineering.ably.com/
Apache License 2.0
2 stars 8 forks source link

Rehearse Workflow #4

Closed QuintinWillison closed 2 years ago

QuintinWillison commented 2 years ago

This is going to allow us to preview the Jekyll site for any pull request, before it lands to main.

QuintinWillison commented 2 years ago

This has been an interesting experiment, but I've just read the many comments on https://github.com/github/pages-gem/issues/651 and it's clear that going this route is going to commit us to old technology with cumbersome workarounds (see https://github.com/ably/ably.github.io/pull/4/commits/933dc87e764323780154a0f56b05eb81d0f3f1d5). It doesn't look like GitHub Pages is likely to upgrade Jekyll so, perhaps, we need to look at building from main branch with our own workflow and pushing to the gh-pages branch (yuck) or use this repository just for distribution and have sources elsewhere. At that point I would also consider using something other than Jekyll as I'm not convinced that it's the best choice these days anyway (I had only selected it because it was seemingly the natural choice to leverage GitHub Pages' hosting). 🤔

QuintinWillison commented 2 years ago

On reflection, I can't really see how GitHub Pages is going to achieve what we want from this site in a maintainable manner. I'm going to:

  1. Switch it off, killing ably.github.io
  2. Rename this repository to something simple and representative: engineering
  3. Remove all Jekyll files to leave just markdown - to be served natively in GitHub's UI

For the time being that will deliver what I needed, which was a canonical home to start collecting, curating and maintaining this content.

We can in future consider serving with some kind of static site engine, but perhaps wait until a standard has been adopted for that elsewhere in the company.

FYI, @mattheworiordan @jaley @jamienewcomb @AndyNicks @owenpearson @tomkirbygreen @ben-xD @ikbalkaya