Build out README.txt file

Comments

drdannielle’s picture

sascher’s picture

Assigned: drdannielle » sascher

I am taking this on for a while since I am working directly with the group

Here is Drdannille's work for the hackpad page

WELCOME
In May, the WH issued an executive order (machine readable). Goal of this module is to provide a Drupal implementation for fulfilling the mandates that came from that EO and the subsequent OMB memo.
A subset of the OMB mandates are required to be complete November 9, 2013. Those are listed on the implementation guide page (project open data github page). The main things we're trying to do today are:

roadmap the module overall

specifically look at implementing those requirements due in november

contribute at the sandbox page - once something releaseable up
will find it at the drupal module page
Matt Grasmick, Acquia - doing this as Drupal community member
Barrett Smith, Acquia -
(acquia not sponsoring module overall)
Ougrowth of personal interest
Bryan Hirsch was one of the initial committers on the nodes
Also talking with the folks at New Amsterdam Ideas - who publish the DKAN Drupal distribution
--
How would the average person use it
Two initial use cases.
The simplest is where the agency does not have a separate enterprise inventory system and they'll just install this module on existing drupal site. They will hand create nodes of this type, filling in the information for their data sets, and that will populate the /data and /data.json pages.
That's enough to fulfill the minimum.
The other case is if an agency has an external enterprise inventory system, in which case they'll use - they'll still install this module but they'll use custom bridge modules they'll need to write which will implement hook open data (enables modules to talk to modules). Our module will create nodes from the data provided by the custom modules that are implementing this hook.
citizens can go to any agency.gov/data page and see a listing of all the datasets that the agency either currently makes publicly available or could make publicly available.
create dataset entry in drupal listing, that will include download URL that will tell people where dataset lives
----
mashups?
because all datasets described using common standard, should be easier to compare datasets from different agencies. but if the fields within the dataset don't align, can't do mashups.
or the taxonomy.
nothing in the mandate addresses that.
continues to be a problem - waht do we do with it.
open data mandate just says data will be made available, datasets described using standard schema.

sascher’s picture

Here's my progress so far:

Open Data
=================
A set of modules help you get your website in line with the US Government's Open Data Policy

This set of modules creates pages that tell the world what data sets your Drupal website has and where to find them (if they're publicly accessible).

These pages will get crawled by the new data.gov to dynamically build out a comprehensive up-to-date catalog of public data sets.

What's the difference between DKAN, DKAN Dataset, and Open Data?

Open Data is lightweight while DKAN installs a more heavy weight solution.

The DKAN distribution allows you to create a standalone website that stores and serves catalogs of datasets, along with their resources. It ships with its own theme, and has an excellent UX for large-scale data management.

The DKAN Dataset module is used by the DKAN distribution. It can also be used as a standalone module. It defines a set of content types, similar to the Open Data module, but with a much larger, more robust feature set. The DKAN Dataset module makes a number of assumptions about your site architecture, and expects resources to be stored in Drupal.

The Open Data module strives to quickly provide a simple, lightweight solution that can be plugged into nearly any existing Drupal site with minimal dependencies.

More Info about the Open Data Policy

In May of 2013, the White House issued an executive order
stating that formats on all US Government websites need be machine-readable (i.e., data are reasonably structured to allow automated processing).

Open data structures do not discriminate against any person or group of persons and should be made available to the widest range of users for the widest range of purposes, often by providing the data in multiple formats for consumption. To the extent permitted by law, these formats should be non-proprietary, publicly available, and no restrictions should be placed upon their use.

acouch’s picture

Great work so far.

Barrett’s picture

Version: » 7.x-1.x-dev

@sascher: it looks like @madmatter pushed a lighter version of this file to dev branch last night. Can you incorporate his changes as well?

grasmash’s picture

I'm adding a few of stans changes.

grasmash’s picture

Status: Active » Fixed

Changes pushed to 7.x-1.x.

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.