mlops/requirements.md

The problem we are trying to solve is we want to be able to curate all of the below assets in a central place that is easy for people to browse and discover. We want to host this on GitHub Pages (we can figure out how to deploy it if you are not familiar with GitHub Pages)

Categories of Assets We have created (a seperate page for each)

1. Blog Posts

   • Providing Data Scientists With New Superpowers
   • Microsoft Official Blog Post
   • Pending - GitHub Official Blog Post - TBD

2. GitHub Actions

   • Action: Submit Argo Workflows on GKE - leverages the gcloud cli to authenticate to your GKE cluster and submit argo workflows.
   • Action: Submit Argo Workflows on K8s (Cloud agnostic) - requires that you supply a kubeconfig file to authenticate to your k8 cluster.
   • Action: Fetch runs from Weights & Biases - W&B is an experiment tracking and logging system for machine learning, and is free for open source projects.
   • Action: To compile, deploy and run Kubeflow pipeline. This action allows you to instantiate Kubeflow pipelines from GitHub directly.
   • Action: Dockerize GitHub repositories automatically as a Jupyter Server
   • aml-workspace - creates an Azure Machine Learning workspace.
   • aml-compute - Manage Azure Compute Resources.
   • aml-run - Run a training job, experiment or pipeline on Azure.
   • aml-registermodel - Register a model on Azure Machine Learning.
   • aml-deploy - Deploy a model to AKS or ACI.

3. Repository Templates

   • fastpages
   • Azure ML + Actions

4. Live Demos / Tutorials

   • GitHub Universe Talk - MLOps
   • Live Demo Actions & ML Workflows
   • Azure ML + Actions Webinar

5. Documentation TBD we have not made this yet, but we want to create documentation as well, and want the documentation theme to be coherent with the rest of the website. When I say documentation. Documentation site should look like this page

6. Team Page We want to list all the members of our team like this page You can use our GitHub profiles to get this started, the team is:

   • @awmatheson
   • @hamelsmu
   • @inc0

Asthetics / Creative Inspiration

• We like the asthetics of primer.style something along those lines as a front page with cards as links to various sections
  • primer.style is also a design system like Jekyll you can use CSS or Gatsby if you are so inclined to use these assets.
• We also like the look and feel of this page https://github.com/features/actions
• Some assets you can try to use (but it is not necessary)
  • Primer CSS
  • GitHub Icons

Requirements

• Preferred static site generator is either Jekyll, Gatsby, or Eleventy
• We want to make it such that we can update the content any of the pages that have a list of resources with CSV or JSON files ourselves. This will make it easy for us to maintain. You can make this happen for example with Jekyll Datafiles. For anything that is a list, we want an image thumbnail that we can add a reference to in the csv or json and that will get rendered for us automatically to make things look nice.
• All youtube videos we supply via a csv/json list for the "Live Demos / Tutorials" page should appear as embedded in the site.
• For other pages we want to be able to update those with markdown.
• All work on this project must be done in this GitHub repo

---

Phase Two Requirements

Please Read Carefully

• Enable Search on every page, similar to Just the docs - The search is fast because it is happening on the client side (this is the only option you have anyways because of static site) - As you search, keywords are highlighted - lunr.js might be helpful. I have used this project for fastpages

• Implement the features of Just The Docs Navigation Structure

  • Ordering pages
  • Exluding pages
  • Pages with children
    • child pages
    • Auto generating Table of Contents
    • children with children
  • Auxilary Navigation
  • In page navigation with Table of Contents

Note: not asking you to implement all features of just-the-docs, just the features pertaining to the navigation strucutre outlined above, and search.