Skip to content

Latest commit

 

History

History
159 lines (107 loc) · 5.62 KB

README.md

File metadata and controls

159 lines (107 loc) · 5.62 KB
Raw

CHTC Website

Source repository for CHTC website

Build Status

Research Computing Guides Guide

View Research Computing Guides Guide Here

How to Edit

Setup (one time, or anytime you want to start fresh)

  1. "Fork" the Github source repository (look for the fork button at the top right of this page: https://github.com/CHTC/chtc-website-source).

  2. Clone the source repository to your own computer.

     git clone https://github.com/CHTC/chtc-website-source

  3. cd into the chtc-website-source folder and add your Github fork to the list of remotes:

     git remote add mycopy https://github.com/myusername/chtc-website-source

Submit a Pull Request (each major change)

  1. Create a branch for new work and switch to it:

     git branch feature-name
 git checkout feature-name

    Your changes will now be saved in this branch.

  2. Make changes to files and add/commit them, following the usual git add/commit workflow. You can test your changes at any time by following the instructions below.

  3. Once you're satisfied with your changes and have committed them, push the branch to your fork:

     git push mycopy feature-name

  4. On Github, go to your fork of the repo. There will likely be a message prompting you to open and submit a pull request.

If you need to update the pull requests, make the necessary changes on your computer, commit them, and then push the same branch to your fork.

Update your copy

To update your local copy of the source repository, make sure that you're on the master branch; then pull from the original CHTC Github repository:

git checkout master
git pull origin master

Testing Changes on Remote

❗ This is a new feature!

To test changes on a publicly viewable development location do the following steps.

You can continue to push commits to this branch and have them populate on the preview at this point!

  • When you are satisfied with these changes you can create a PR to merge into master
  • Delete the preview branch and Github will take care of the garbage collection!

Testing Changes Locally

Quickstart (Unix Only)

  1. Install Docker if you don't already have it on your computer.
  2. Open a terminal and cd to your local copy of the chtc-website-source repository
  3. Run the ./edit.sh script.
  4. The website should appear at http://localhost:8080. Note that this system is missing the secret sauce of our setup that converts the pages to an .shtml file ending, so links won't work but just typing in the name of a page into the address bar (with no extension) will.

Run via Ruby

bundle install
bundle exec jekyll serve --watch -p

Run Docker Manually

At the website root:

docker run -it -p 8001:8000 -v $PWD:/app -w /app ruby:2.7 /bin/bash

This will utilize the latest Jekyll version and map port 8000 to your host. Within the container, a small HTTP server can be started with the following command:

bundle install
bundle exec jekyll serve --watch --config _config.yml -H 0.0.0.0 -P 8000

Formatting

Markdown Reference and Style

This is a useful reference for most common markdown features: https://daringfireball.net/projects/markdown/

To format code blocks, we have the following special formatting tags:

```
Pre-formatted text / code goes here
```
{:.sub}

.sub will generate a "submit file" styled block; .term will create a terminal style, and .file can be used for any generic text file.

We will be using the pound sign for headers, not the == or -- notation.

For internal links (to a header inside the document), use this syntax:

  • header is written as 
     ## A. Sample Header
  • the internal link will look like this: 
     [link to header A](#a-sample-header)

Converting HTML to Markdown

Right now, most of our pages are written in html and have a .shtml extension. We are gradually converting them to be formatted with markdown. To easily convert a page, you can install and use the pandoc converter:

pandoc hello.shtml --from html --to markdown > hello.md

You'll still want to go through and double check / clean up the text, but that's a good starting point. Once the document is converted from markdown to html, the file extension should be .md instead. If you use the command above, this means you can just delete the .shtml version of the file and commit the new .md one.

Adding "Copy Code" Button to code blocks in guides

Add .copy to the class and you will have a small button in the top right corner of your code blocks that when clicked, will copy all of the code inside of the block.

Adding Software Overview Guide

When creating a new Software Guide format the frontmatter like this:

software_icon: /uw-research-computing/guide-icons/miniconda-icon.png software: Miniconda excerpt_separator: <!--more-->

Software Icon and software are how the guides are connected to the Software Overview page. The excerpt_seperator must be <!--more--> and can be placed anywhere in a document and all text above it will be put in the excerpt.