Skip to content

byandell/ESIIL

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 Cannot retrieve latest commit at this time.

History

92 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Welcome to the README for Brian Yandell's ESIIL Collaboration repository. ESIIL is the Environmental Data Science Innovation and Inclusion Lab, with GitHub pages at https://github.com/CU-ESIIL. This repository is a fork of https://github.com/CU-ESIIL/Postdoc_OASIS, with my changes to have this serve as a hub for my research collaboration with ESIIL researchers. It creates a (virtual) subfolder ESIIL to my GitHub portfolio byandell.github.io, displayed as byandell.github.io/ESIIL.

Construction

This site was created under direction of ESIIL staff (Ty Tuff) using the following steps:

  • Go to https://github.com/CU-ESIIL/Postdoc_OASIS
  • Fork your own copy of this repo to your GitHub account. Mine is https://github.com/byandell/ESIIL.
    • Click Use this Template (green button to right) menu.
    • Click Create a new repository entry.
    • Type in repository name (owner should be your github ID; repo name should be what you want as subfolder of your portfolio)
    • Click Create Repository (green button on lower right corner)
  • Modify a few things on this repo
    • Settings: Actions: General: Workflow permissions: change to Read and Write Permissions and save
    • Settings: Pages: Build and development: Branch: select deploy from a branch and (can only do this after you do a few more steps (below)
      • Select branch gh-pages
      • Select folder /docs
  • Modify "mkdocs.yml" file under Code

Once steps 1-4 (except 3b) are done, your repo should be building. You can check with Actions to see progress. Then go to https://byandell.github.io/ESIIL to see the result.

Work displayed on your gh-pages branch in the folder docs/ will be the main content of your web page. That is, git-commits of modifications to index.md in https://github.com/byandell/ESIIL/docs will appear on https://byandell.github.io/ESIIL.

References on Creating a Portfolio Website

All development of GitHub Page occurs in the main branch with pull request to gh-pages branch. This can be automated with mkdocs as was done on the ESIIL prototype; however, if you do that mkdocs will overwrite changes to ghpages branch`.

Open questions

There are some things I do not understand.

  • What is purpose of files in main if deployment is in gh-pages.
    • I see how this makes sense using mkdocs to make documents from main to gh-pages. Then I would want to only edit on main.
    • If I am not using mkdocs, what needs to be in main?
  • The Postdoc page has a nice banner, which seems to be in gh-pages/index.html.
  • Without using mkdocs, why do my pages have header ESIIL?
    • Where is this in code tree?

Releases

No releases published

Packages

No packages published

Languages

  • Dockerfile 100.0%