Git Product home page Git Product logo

gsocguides's Introduction

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 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!

Run Markdownlint locally

npm install markdownlint-cli
./node_modules/.bin/markdownlint  pages

Want to contribute?

Please see the CONTRIBUTING instructions.

gsocguides's People

Contributors

aishtron7 avatar benhenning avatar davidauza-engineer avatar dependabot[bot] avatar doct0rx avatar dpshelio avatar dsanders11 avatar edwardbetts avatar gandalfgwaihir avatar gifti258 avatar jamescrook avatar jonbrohauge avatar kevinnls avatar majora320 avatar marcoscaceres avatar maryr37 avatar molkree avatar nikhita avatar nikunj-taneja avatar orestisfl avatar oriolabril avatar rspier avatar sahilkr24 avatar seun-beta avatar stephanietaylor avatar thealphadollar avatar theoretick avatar waharnum avatar willnorris avatar woswos avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

gsocguides's Issues

Document about changes to an accepted project

The guide does not contain information about what happens in the case of changes to an accepted project. The email that is sent to mentors and org admins after the results are announced contains this information. I think it makes sense to document this in the guide.

Ref: https://developers.google.com/open-source/gsoc/2017/mentor-oa-announcements#may_2_2017_next_steps_for_all_mentors_and_org_admins

Changes to a Student’s Accepted Project

You and your student can decide to change the project from what was originally proposed BUT you both need to agree on the change. Neither the mentor nor the student should pressure the other person into making huge changes.

Last year we had students who were upset because they felt they couldn’t tell their mentor no. Many took on more than they could handle. In most of these cases the new project was completely different from what had been originally proposed and many students did not have the appropriate background knowledge or sometimes barely knew the particular coding language required. Be fair to your students -- set them up for success. In return they should also be flexible to change the scope of the project (within reason) if the org finds it necessary.

Students are able to edit their project title and abstract for the next month.

@rspier wdyt?

fyi @sttts

A todo should be corrected

{Process for 2022 still being developed with new webapp - more details coming soon.}
in https://google.github.io/gsocguides/mentor/selecting-students-and-mentors.html should hopefully be correctable today.

It matters because I really much want to know exactly what occurs if a student we place on top is selected by another org. We have multiple students which are great for the same project, and would love to indicate that if the first candidate is not available, we want the second one on the same project , however we do not want to accept both candidate, and with current documentation, it's not clear whether it's even possible

CLA

I signed it , getting told I didn’t

add note regarding picking one's own students

These threads culminate in a note that one should not select their own student to be a mentee for the program.

https://groups.google.com/forum/?utm_medium=email&utm_source=footer#!msg/google-summer-of-code-mentors-list/X1a2H1TvF5o/sF425LiWAAAJ
https://groups.google.com/d/msgid/google-summer-of-code-mentors-list/CAKPprLLSeEWe2kzAcMBh3Or1Y6sCNWNbV5HOaHwLb3y4p0BUCw%40mail.gmail.com

Also worth mentioning the guidance regarding choosing students from your own school/department.

Link not present

There are lots of link in the manual but those are not hyperlinked. This manual is written in markdown, so it is possible to hyperlinked all the links.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.