codespace idea

[MichaelAkridge-NOAA]

Codespace Idea

Just an idea to possibly help streamline codespace environment generation and setup

Link: https://github.com/MichaelAkridge-NOAA/codespace-generator

• This will dynamically generate basic codespace development container configurations (devcontainer.json) for each container image listed in a GitHub organization(nmfs-opensci)'s package registry.
• Proof of Concept. Still needs to be updated, expanded and configured to enhance codespace generation and to make it work with each image type/base

[MichaelAkridge-NOAA]

Codespace Idea #2 - Codespace Designer

Github page that takes in the NMFS-Opensci image list, and allows users to customize/design a codespace devcontainer file as they see fit using easy option selectors.

• Use to configure a GitHub Codespace environment
• Powered by Github Pages to help design a codespace devcontainer file
  • Link: https://michaelakridge-noaa.github.io/codespace-designer/

Design a Codespace

[eeholmes]

@MichaelAkridge-NOAA This is fantastic! Thoughts on how to combine this with a Docker Stack page? By the looks of your GitHub Page, you are a better GitHub Page designer than I am. Maybe a GitHub Page with a top nav bar that looks a little like pkgdown

• Overview tab: overview of the NMFS Data Science Docker Stack
• Images tab: Dropdown that goes to each image README.md (in the images folder)
• Codespace Designer tag: that goes to your codespace designer?

Does it create by chance the button that opens the Codespace? Like on this page https://github.com/eeholmes/earthdata-cloud-cookbook/blob/main/README.md I think I saw that you have buttons like this too?

[MichaelAkridge-NOAA]

@eeholmes Thanks! And what you listed already sounds like a great idea to me. I'll create a fork and try to test a few Github page ideas.

The codesapce designer doesn't currently create the button/links to start the codespace, just download, but I'll add that to my list to explore for sure.

I haven't tried to make one before, but an oauth app might be interesting all in one solution.

• https://docs.github.com/en/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps#about-oauth-apps

It could potentially, once authorized by the user, use the github api to create a new repo with the devcontainer file and launch the codespace all in one.

[MichaelAkridge-NOAA]

@eeholmes Here is a first test at some of the Github Page ideas in action.

• Test GH URL: https://michaelakridge-noaa.github.io/container-images/
• Test Fork: https://github.com/MichaelAkridge-NOAA/container-images

  Overview tab: overview of the NMFS Data Science Docker Stack

• currently home/landing page, but can be changed
• pulls from readme

Images tab: Dropdown that goes to each image README.md (in the images folder)

• menu list calls packages.json (generated via github action to list nmfs-opensci packages)
• can still be optimized; another option would be to use API calls

Links to Dev Info Readme and Codespace Designer

[MichaelAkridge-NOAA]

@eeholmes just-the-docs github page test

• Test GH URL: https://michaelakridge-noaa.github.io/nmfs-opensci-container-images/

• Test Fork URL: https://github.com/MichaelAkridge-NOAA/nmfs-opensci-container-images

  Overview Tab

  

  Image Readmes

• Image readme just needs headers added to be integrated into nav. e.g.

  ---
  layout: default
  title: jupyter-multiple-conda
  parent: Image Info
  nav_order: 2
  has_children: false
  ---

  

• Has a lot of nice features like search

[eeholmes]

Some other notes

https://cs50.medium.com/providing-students-with-standardized-cloud-based-programming-environments-at-terms-start-for-a82b0e5c4fae