des_ncsa's Introduction

DES Data Management (DESDM) public data release website

This repository is the source code for the DESDM public data release website at https://des.ncsa.illinois.edu/.

Workflow for contributing content updates

Install docker and git.
Fork the repo https://github.com/des-labs/des_ncsa to https://github.com/$GITHUB_USER/des_ncsa where $GITHUB_USER is your GitHub account username.

Clone your fork locally and create a dev-$RELEASE_NAME branch, where $RELEASE_NAME is some short meaningful name like dr2 or y6bao.

CLONE_DIR="$HOME/src/$GITHUB_USER/des_ncsa"
git clone https://github.com/$GITHUB_USER/des_ncsa $CLONE_DIR
cd $CLONE_DIR
git checkout -b dev-$RELEASE_NAME

Build the Docker image.

docker build . -t desdm-public --platform linux/x86_64

Configure the webserver to run in "development mode".

docker run --rm -d --name desdm-public --platform linux/x86_64 \
    -p 8888:8080 \
    -v $(pwd):/home/des \
    -u $(id -u) \
    -e DEBUG_ENABLED="true" \
     desdm-public

Open your browser to http://127.0.0.1:8888 to view the website.
Edit and save the relevant HTML files. Reload the page and see the results. Repeat this step until satisfied.

Commit only the substantive changes to the Git repo and push the updates to your GitHub fork.

git add [path/to/file_1] [path/to/file_2] [...]
git commit -m 'Updated release page blah'
git push origin dev-$RELEASE_NAME

Create a pull request to merge and publish your changes. You must inform the DES Science Release community via the #sci-release Slack channel to allow for a peer review of the submission before it can be accepted.