https://github.com/google/gsocguides

Google Summer of Code Mentor and Student Guides
https://github.com/google/gsocguides

Last synced: about 1 month ago
JSON representation

Google Summer of Code Mentor and Student Guides

• Host: GitHub
• URL: https://github.com/google/gsocguides
• Owner: google
• License: other
• Created: 2017-09-27T20:28:23.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-06-25T19:34:22.000Z (3 months ago)
• Last Synced: 2024-06-25T21:23:09.354Z (3 months ago)
• Language: CSS
• Homepage: https://google.github.io/gsocguides/
• Size: 3.28 MB
• Stars: 401
• Watchers: 32
• Forks: 152
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
# Google Summer of Code Guides

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

## Template

The template and build is based on

Documentation can be found at

## Local Development

``` shell

# 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.

```bash

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

```bash

bundle install --path vendor/bundle

bundle update github-pages

rm -rf vendor/bundle

```

Don't forget to rebuild the docker image!

## Run Markdownlint locally

```shell

npm install markdownlint-cli

./node_modules/.bin/markdownlint  pages

```

## Want to contribute?

Please see the [CONTRIBUTING](CONTRIBUTING.md) instructions.