Skip to content
Google Summer of Code Mentor and Student Guides
CSS HTML Ruby JavaScript Shell Dockerfile Makefile
Branch: master
Clone or download

Latest commit

Molkree and rspier - some small typos
- changed wording about mentors from he/she to they
- some small fixes in Glossary
Latest commit c25f44d Mar 15, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode Check in baseline copy of documentation theme Sep 18, 2017
_data Add Special Circumstances page to sidebar. Sep 30, 2019
_includes Add "Edit page" link to footer of pages. Dec 14, 2017
_layouts Add "Edit page" link to footer of pages. Dec 14, 2017
css Remove explicit <Table of Contents> from TOC Sep 27, 2017
images add sun logo to topnav Sep 27, 2017
js Reorganize third party code into third_party Sep 27, 2017
pages - some small typos Mar 16, 2020
third_party Reorganize third party code into third_party Sep 27, 2017
.gitignore Check in baseline copy of documentation theme Sep 18, 2017
404.md Check in baseline copy of documentation theme Sep 18, 2017
AUTHORS Add authors to AUTHORS file. Sep 27, 2017
CONTRIBUTING.md Add LICENSE, CONTRIBUTING, and start of a README.md. Sep 27, 2017
Dockerfile Software updates Mar 15, 2018
Gemfile Check in baseline copy of documentation theme Sep 18, 2017
Gemfile.lock
LICENSE one single license file Sep 27, 2017
Makefile Add a default help target in the Makefile. Sep 30, 2019
README.md Upgrade to latest Gem versions. Sep 30, 2019
_config.yml Remove copyright year range Jan 7, 2020
createtag Correct spelling mistakes Mar 29, 2019
docker-compose.yml Check in baseline copy of documentation theme Sep 18, 2017
feed.xml Check in baseline copy of documentation theme Sep 18, 2017
search.json Check in baseline copy of documentation theme Sep 18, 2017
sitemap.xml Check in baseline copy of documentation theme Sep 18, 2017
tooltips.json Check in baseline copy of documentation theme Sep 18, 2017

README.md

Google Summer of Code Guides

This project contains the Google Summer of Code Mentor Guide and Student Guide.

Template

The template and build is based on https://github.com/tomjoht/documentation-theme-jekyll

Documentation can be found at http://idratherbewriting.com/documentation-theme-jekyll/

Local Development

# Build docker image (once)
make build-image

# Run server (listens on port 4000)
make serve

Adding New Pages

If you're adding new pages between existing pages, use this script (or similar) to renumber the existing pages.

for i in $(seq 28 -1 15);
    do n=$((i+1));
    fi=$(echo $i-*.md);
    fn=$(echo $fi | sed -e "s/${i}-/${n}-/");
    git mv $fi $fn;
    perl -pi -e "s/^order: $i\$/order: $n/" $fn;
done

# 28 is the current last page.
# 15 is the page to insert before.
# Iterate backwards to ensure there's only one page with each index at a time.

We need to do this because a) we're naming pages after their order, and b) the Next/Prev button requires all the order numbers to be contiguous. You can't skip any.

Upgrade Ruby Gems

bundle install --path vendor/bundle
bundle update github-pages
rm -rf vendor/bundle

Don't forget to rebuild the docker image!

Want to contribute?

Please see the CONTRIBUTING instructions.

You can’t perform that action at this time.