ol-infrastructure icon indicating copy to clipboard operation
ol-infrastructure copied to clipboard

Transform the docs folder in this repo into a Github Pages/Jekyll site for OL Platform Engineering

Open feoh opened this issue 2 years ago • 0 comments

Description/Context

Right now, all our docs live at https://github.com/mitodl/ol-infrastructure/tree/main/docs are just Markdown files.

Navigating to a given doc is moderately painful, and there's no searchability short of good old fashioned grep in the checked out repo.

This isn't amazing and isn't the kind of easy consumability we want in order to bar raise our operational excellence.

Plan/Design

Use the example set by http://mitodl.github.io/handbook/ to create a separate MIT OL Platform Engineering Github Pages/Jekyll site.

Organize it by categories at first, with a very brief routing page to help people understand which category will contain the docs they want.

Ensure that the site is searchable from the webpage.

feoh avatar Dec 19 '23 17:12 feoh