Link Search Menu Expand Document

Inner loop, testing your changes using Github Codespaces

This repo has a github codespace dev container defined, this container is based on ubuntu 20.04 and contains all the libraries and components to run github pages locally in Github Codespaces(ruby 2.7, jekyll, gems, vscode tasks). To test your changes locally do the following:

  • Enable Github codespaces for your account
  • Fork this repo
  • Open the repo in github codespaces

  • Wait for the container to build and connect to it
  • Understand the folder structure of the Repo:
    • “apim-lab” folder , contains all the mark down documentation files for all the challenges
    • “assets” folder, contains all the images, slides, and files used in the lab
  • Understand the index, title, and child metadata used by just-the-docs theme
  • Run the website in github codespaces using the built-in task:
    • the “.vscode” folder contains a tasks.json file with all the tasks necessary
    • For example, Pressing ⇧⌘B on a mac, or running Run Build Task from the global Terminal menu will run the website locally in github codespace. See Vscode docs for other OS key bindings.

Enabling Codespace