Skip to content

kjantin/knight-proposal

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

#Ways to practice responsible development data - the online living document

##About the book

This book, organized around the data lifecycle, highlights responsible data concerns, recommendations, and real-world examples in the context of international development programming. It was collaboratively produced in three days at the Responsible Data Forum Booksprint by a group of 13 people.

the data lifecycle

Parts of the Primer on Responsible Development Data were used and expanded upon in this book.

##Why a living document

The collective knowledge of the 13 co-writers is impressive, but the real life challenges of dealing with data for development responsibly and ethically change with every new development challenge and technological breakthrough. We decided to open the book up for others to comment, propose changes, or fork it for their own purposes.

##How to contribute

###1. Comment and annotate

Just select any part of the text and leave your comment in the sidebar. You'll also be able to see where others have commented, and respond to their comments. We are using the amazing hypothes.is plugin for commenting. You'll need to create a hypothes.is account to save your comment: we trust hypothes.is to treat your data responsibly, and you can sign in pseudonimously as well.

###2. File issues, fork the repo, make changes, and send us a pull request

For the more tech-savvy users: you can use all the usual Github collaborative development techniques. Fork, branch, push, pull, spoon (maybe don't spoon). There are many good tutorials for using git and Github, like this one.

###3. Contact us

Prefer to do it the old fashioned way? We got you covered. Just send an email to contact AT responsibledata DOT io.

#Tech specs


Do you like how we built this site? We think it's pretty nifty. Here's the rundown of the tech we're using, if you want to roll your own similar project.

###Markdown and Jekyll

All the content is organized and categorized in Markdown files, using Jekyll to automatically build the HTML structure.

###Template

We're using Byron Ruth's Jekyll Docs Template for the structure of the website, that we customized and styled to fit our needs. The template is very well documented and has step-by-step instructions on how to install and use it.

Thanks, Byron!

###Commenting and annotation

The impressive hypothes.is. A breeze to install, just add a single line of code to your pages:

<script async defer src="//hypothes.is/embed.js"></script>

Hypothes.is takes care of everything else. They also have browser plugins, bookmarklets, and a Wordpress plugin.

###File editing

We recommend prose.io for editing the markdown files directly in your browser. You link it to your Github account, and prose.io lets you easily edit files with a clean and minimal interface. No need to download or install anything. Prose.io is developed and maintained by the great people at Development Seed.

##Enjoy.

We're looking forward to your comments and contributions and hope this document will be useful for your work.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 71.8%
  • CSS 23.2%
  • Ruby 4.8%
  • JavaScript 0.2%