www.pyhpc.io

This repository contains the landing page and blog for www.pyhpc.io.

Contributing

Currently the website is a set of static pages generated by Pelican. The generated content is uploaded to Github Pages.

Please feel free to contribute in what ever capacity you feel best.

Here are a few ways you can contribute:

Add a news update

• Fork the repository on Github

• Clone the fork. Be sure to use the --recursive option to download the submodules.

$ git clone --recursive [email protected]:aterrel/pyhpc.github.com
Cloning into 'pyhpc.github.com'...
remote: Counting objects: 74, done.
remote: Compressing objects: 100% (68/68), done.
remote: Total 74 (delta 3), reused 73 (delta 2)
Receiving objects: 100% (74/74), 248.52 KiB | 0 bytes/s, done.
Resolving deltas: 100% (3/3), done.
Checking connectivity... done
$ cd pyhpc.github.com

• Ensure you're on the source branch.

$ git checkout source

• Create a new branch with the name of your news item.

• The contents of the site can be found in content.

$ cd content; ls
 news pages static

* static: static content to be copied,
* news: The "blog" like content,
* pages: the set of pages to be displayed

• Add a news item in content/news, see Pelican docs for details. Please use Markdown! An example of a news update is shown:

$ cd content/news
$ cat << EOF > 2013-10-25-test.md
> Title: Test
> Date: 2013-10-25
> Categories: 
> Author: Andy R. Terrel <[email protected]>
> Summary: Testing
> 
> Testing how this works!
> 
> EOF

• Push to your fork on github

• Create a pull request

• Once your request has been merged, an owner of the repository will push the changes to the Github Pages branch.

• To generate a local version of the website, run make html from the root directory of the repository.

• To view the local version of the website, run make serve.

$ make serve
< open browser to http://127.0.0.1:8000 >
( you should see your test page in the News and archives )
< Ctrl-C to exit server on terminal >

Updating pages

• Pages are separated by year:

$ cd content/pages
$ ls
 sc13  sc14  sc20

• Edit or add a new page

$ vim sc20/new_page.md

• Once again go to the root directory, make and view your changes.

$ make html && make serve

Contribute to the theme

The theme for the website is a Git submodule. Please contribute to it here.