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 6 forks source link

Build static site and host at `engineering.ably.com` #43

Open QuintinWillison opened 1 year ago

QuintinWillison commented 1 year ago

From @mattheworiordan on this (sent to me via Slack DM, August 2022):

Do you think it’s worth putting a static site generator over this content and hosting on engineering.ably.com. The argument for this is that links are manageable moving forward i.e. if we have engineering.ably.com now and we move to this static site, we can set up redirects for specific pages. If in future we move to another platform or consolidate more of this content somwehere else aagain, we can set up redirects per page. Using a Github repo, we don’t get any of those benefits. Plugging in a static site generator to render Markdown should be trivial, and we could always include the Github icon in the interface to allow people to issue PRs / view the source etc. WDYT

To which I responded with:

I have no objection to publishing to a static site, and there are benefits. My only reason for continuing, for now, with just GitHub-native rendering was the simplicity of it.

mattheworiordan commented 1 year ago

See https://ably-real-time.slack.com/archives/CURL4U2FP/p1672929783408049?thread_ts=1672928918.343459&cid=CURL4U2FP.

Using the default Jekyll powered pages feature of Github, this site is now published to https://engineering2.ably.com as an example of how this can work.

Taking this approach should simplify things in that no static site builder is needed, we can just use the standard Github functionality. What is outstanding is: