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.
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)
- Click
- Modify a few things on this repo
Settings: Actions: General: Workflow permissions
: change toRead and Write Permissions
and saveSettings: Pages: Build and development: Branch
: selectdeploy from a branch
and (can only do this after you do a few more steps (below)- Select branch
gh-pages
- Select folder
/docs
- Select branch
- Modify "mkdocs.yml" file under
Code
site_url
: https://byandell.github.io/ESIIL (be sure this does not conflict with any pages on your personal website if you have one -- see https://github.com/byandell/byandell.github.iorepo_url
: https://github.com/byandell/ESIIL- other changes are optional, but these are needed.
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.
- ESIIL Data Short Course: Create your own portfolio webpage
- GitHub Pages Documentation
- Publish Your Project Documentation with GitHub Pages
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`.
There are some things I do not understand.
- What is purpose of files in
main
if deployment is ingh-pages
.- I see how this makes sense using
mkdocs
to make documents frommain
togh-pages
. Then I would want to only edit onmain
. - If I am not using
mkdocs
, what needs to be inmain
?
- I see how this makes sense using
- The Postdoc page has a nice banner, which seems to be in
gh-pages/index.html.
- Presumably this was created by
mkdocs
using the info in main/mkdocs.html
- Presumably this was created by
- Without using
mkdocs
, why do my pages have header ESIIL?- Where is this in code tree?