Resistance Safe Houses

Collaboration using Gitub and geojson

Step 1: Fork this!

There are two methods to contributing on GitHub. The first and most direct is for the owner to grant push access to you. This allows you to clone their repository directly and push changes without requiring their approval. Very convenient, but also a security nightmare and a real hassle to add and remove people from the list.

The second way to contribute is to fork the repository (fork: make a complete copy of the repository in your github account), make changes, then make a pull request to the original owner (pull request: Pull requests let you tell others about changes you've pushed to a repository on GitHub.)

So, Step 1 is to FORK this repository, which you can do so by pressing the fork icon on this page:

Step 2: Adding content in geojson format

Create a new geojson file:

Go to geojson.io and use the marker icon to place a marker at the Safehouse (cafe / bar) of your choice. This creates a Feature Collection with a geometry type Point...

Add a short review of your safehouse. In particular add:
- Name: Cafe name
- Address: Cafe address
- Review: quick review or star rating
- Contributor: your name

Copy the geojson text displayed in geojson.io

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "marker-color": "#7e7e7e",
        "marker-size": "medium",
        "marker-symbol": "",
        "name": "Tsubu Bar",
        "Address": "gate 6, swanston st, building 1888 university of Melbourne 3010"
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          144.96211051940918,
          -37.79845872037568
        ]
      }
    }
  ]
}

Step 3:

Start a new file in github, using the newfile button. You will need to do this in Your Fork. Make sure you:

create this file in the geojsons directory (by clicking on that directory)
name this file with the .geojson extension

Once you have created the file, paste in the contents of your geojson

Step 4: Create a pull request

Time to create a pull request! In the main page of your resistance-safe-houses repository, click the new pull request button.

Step 5: Merging pull requests

The owner of the repository will now 'merge' in the pull requests (after carefully reviewing the quality of each safehouse). Then pull the changes back to a local version of the repository on her computer.

Step 6: Python Script merge the geojsons

In the local repository, the owner can now runpython merge_jsons.py will merge the new files (merge all *.json files in the geojsons directory)

Don't forget to push these changes back to github..

Step 7: Pull the upstream changes into your Fork

Run the following commands from the directory where you want to store a local copy of your repository.

First, make a local copy of the repository using git clone

git clone https://github.com/USERNAME/resistance-safe-houses
cd resistance-safe-houses

There is one more thing left to do: keeping up to date with upstream. In Git upstream refers to some remote repository that you consider higher or more authoritative than yours. At the moment your local repository has one upstream repository, your GitHub repository. When you type git pull, that’s where it pulls from

git remote add upstream https://github.com/dansand/resistance-safe-houses.git
git fetch upstream
git merge upstream/master
git push

Push the merge to back to your GitHub repository.

git push origin master

Step 8: view the results

We embed the geojson into a gh-pages (project) web page here: http://dansand.github.io/resistance-safe-houses/

#Notes

##Acknowledgements

The idea for this lesson came from Open Tech School:

http://opentechschool.github.io/social-coding/core/underground.html

##Rendering in github

Jupyter/IPython notebook (.ipynb) files will render directly on GitHub. GitHub encourage the adoption of the Jupyter notebook as a standard file format across a wide range of fields. Jupyter notebook files are a JSON-based open document format that supports code and results, narrative text, images, and equations in one file.
Any .geojson file in a GitHub repository will now be automatically rendered as an interactive, browsable map, annotated with your geodata.
images - png, etc
pdf
3D (STL) File Viewing

##Project pages in github

##Geojson format

GeoJSON is a format for encoding a variety of geographic data structures.

The JSON format expects the keys to a dictionary to be strings. If you have other types as keys in your dictionary, trying to encode the object will produce a ValueError. One way to work around that limitation is to skip over non-string keys using the skipkeys argument:

##Future of collaboration

##Git lessons

Learn the basics of git (as opposed to github), with these Software Carpentry lessons:

http://swcarpentry.github.io/git-novice/