Skip to content
This repository was archived by the owner on Jun 18, 2024. It is now read-only.

Commit e9941d5

Browse files
committed
Merge branch 'typos' of https://github.com/jpmckinney/project-open-data.github.io into jpmckinney-typos
Conflicts: api-basics.md index.md
2 parents 3c7e456 + f2f08f2 commit e9941d5

11 files changed

+22
-22
lines changed

Diff for: CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## How to Contribute
44

5-
This project constitutes a collaborative work ("open source"). Federal employees and members of the public are encouraged to improve the project by contributing. For more information, please see [the faq](/faq/)
5+
This project constitutes a collaborative work ("open source"). Federal employees and members of the public are encouraged to improve the project by contributing. For more information, please see [the FAQ](/faq/)
66

77
Contributions can be made, primarily in two ways:
88

Diff for: api-basics.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ So really when we say errors we mean bad things happen (a database server goes d
8787

8888
An API starts with the desire to share data or resources that a company offers. It's built with technologies like REST, XML, and JSON, and supported through documentation, along with a handful of code samples to show how to use it.
8989

90-
An API and its supporting developer area are created. And then, what's next? How does a simple API area build community? How does it evolve into a thriving ecosystem like Facebook’s of Foursquare's?
90+
An API and its supporting developer area are created. And then, what's next? How does a simple API area build community? How does it evolve into a thriving ecosystem like Facebook’s or Foursquare's?
9191

9292
It all starts with developers. Giving developers a self-service, resource-rich environment where they have the spotlight and a voice that will encourage them in turn to contribute to the API community.
9393

@@ -97,7 +97,7 @@ Resources for developers need to be abundant and well organized. Common resource
9797

9898
Support and resources can create a positive feedback loop among developers and encourage activity that will ideally spread to other users.
9999

100-
Developers can’t be expected to visit an API area regularly, so an API community needs to extend its reach to existing social network and developer communities including Twitter, LinkedIn, Github, and Stack Exchange.
100+
Developers can’t be expected to visit an API area regularly, so an API community needs to extend its reach to existing social network and developer communities including Twitter, LinkedIn, GitHub, and Stack Exchange.
101101

102102
Even more than just a presence on these social networks, an API needs to have an offline presence too -- something that can be accomplished by attending conferences, meet-ups, and hackathons, for example. These activities will only serve to strengthen the API community.
103103

Diff for: catalog.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@ To fulfill the requirements of this memorandum, agencies should begin to describ
3535

3636
### JSON
3737

38-
JSON is a lightweight and simple way to represent machine-readable data. It is quickly becoming the *de facto* standard for shuttling data across the internet, fueled primarily by the rise of mobile and APIs. Modern programing languages can interpret and produce JSON out of the box.
38+
JSON is a lightweight and simple way to represent machine-readable data. It is quickly becoming the *de facto* standard for shuttling data across the internet, fueled primarily by the rise of mobile and APIs. Modern programming languages can interpret and produce JSON out of the box.
3939

4040
The JSON representation of the catalog should track directly to the RDFa version, with the exception that JSON keys should not contain the domain prefix (e.g., `dct:title` becomes `title` and `dct:description` becomes simply `description`). Catalogs should be composed of an array of JSON objects, and all fields other than keywords should be a string (where keywords is an array of strings).
4141

4242
### RDFa Lite
4343

44-
[RDFa Lite](http://www.w3.org/TR/rdfa-lite/) is a subset of RDFa (Resource Description Framework in Attribute) that provides a common syntax for expressing metadata on websites in a way that computers can understand and begin to formulate knowledge about those data about your organization. RDFa Lite embeds itself in existing, standard HTML pages. For example, if previously a dataset was described as `<h2>Name of Dataset</h2>`, RDFa would extend that markup as `<h2 property="dct:title">Name of Dataset</h2>` (notice the additional of the property field). This additional metadata is not visible when the page is rendered, and does not affect the page layout or content. It simply provides an additional level of description for search engines, crawlers, and other programatic consumers of your site's content. It is acceptable for the RDFa Lite file to contain only the machine-readable metadata, but agencies may wish to add human readable content to display the metadata to the public if they so desire.
44+
[RDFa Lite](http://www.w3.org/TR/rdfa-lite/) is a subset of RDFa (Resource Description Framework in Attribute) that provides a common syntax for expressing metadata on websites in a way that computers can understand and begin to formulate knowledge about those data about your organization. RDFa Lite embeds itself in existing, standard HTML pages. For example, if previously a dataset was described as `<h2>Name of Dataset</h2>`, RDFa would extend that markup as `<h2 property="dct:title">Name of Dataset</h2>` (notice the additional of the property field). This additional metadata is not visible when the page is rendered, and does not affect the page layout or content. It simply provides an additional level of description for search engines, crawlers, and other programmatic consumers of your site's content. It is acceptable for the RDFa Lite file to contain only the machine-readable metadata, but agencies may wish to add human readable content to display the metadata to the public if they so desire.
4545

4646

4747
Generating Machine-Readable Reporting Files

Diff for: cdo-position-description.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: default
3-
title: CDO Position Descripton
3+
title: CDO Position Description
44
permalink: /cdo/
55
filename: cdo-position-description.md
66
---
@@ -108,9 +108,9 @@ The CDO is not responsible for the security of information. That responsibility
108108
Success for the CDO is developing culture of data sharing within the organization and planning to make data available to share as part of Agency process, rule makings and IT system design. Data management, well-led by the CDO, should be a profit center for the enterprise, or in the case of a Federal agency, a means to avoiding costs and increasing productivity. Success looks like:
109109

110110
* Measurably improved data quality and data management practices to track, protect, and publish data
111-
* Publishing all publically available data electronically is structured, machine-readable formats packaged in a variety of formats and syndicated to a variety ways to support a variety to meet the needs of a variety of customers
111+
* Publishing all publicly available data electronically is structured, machine-readable formats packaged in a variety of formats and syndicated to a variety ways to support a variety to meet the needs of a variety of customers
112112
* Identity of regulated entities, products and services offered as a service to IT systems. Real-time company files and other profiles such as “market fast facts” that can be looked up by unique, commonly known identifiers such as call signs
113-
* Data increasingly syndicated to other parties and publically available information services from third parties based on real-time, machine accessed services.
113+
* Data increasingly syndicated to other parties and publicly available information services from third parties based on real-time, machine accessed services.
114114
* Exposing Agency tools and data in manner that helps speeds products and innovation to markets
115115
* Validating data collections will support planned policy making prior to NPRMs. Data collection NPRMs that include prototypes of data collections
116116
* Being able to rapidly develop data services and offerings based on requests from academics, policy makers, industry, advocates, and public

Diff for: faq.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ No, the files should be located at agency.gov/data web space. Each agency shoul
146146

147147
1. For websites that are composed of static HTML, simply host the data.json file at the designated location.
148148
2. If needed, one may also host the file by using /data.json/index.html to provide the same functionality.
149-
3. Sites that utilize WordPress may modify and employ the open-sourced [Datafiles Wordpress Plugin](https://github.com/GSA/datafiles-wordpress-plugin).
149+
3. Sites that utilize WordPress may modify and employ the open-sourced [Datafiles WordPress Plugin](https://github.com/GSA/datafiles-wordpress-plugin).
150150
4. Sites that utilize Drupal may modify and employ the open-sourced [Digital Strategy Drupal Module](https://github.com/FCC/digital_strategy).
151151

152152

@@ -188,7 +188,7 @@ Agencies are required to implement the Open Data Policy within six months.
188188

189189
### What is the relationship between NIEM and the efforts underway for the Digital Government Strategy, The Open Data Policy, and Data.gov?
190190

191-
Each of these initiatives has a discreet, targeted focus, but all are aimed at increasing access and use of government data. Data.gov has provided a central place to find data and applications for publically releasable information. New applications and services to better serve citizens have been produced as a result in the increase of information made available through Data.gov. The DGS/ODP policy establishes a framework to help institutionalize the principles of effective information management at each stage of the information’s life cycle. The framework can help agencies build information systems and processes in a way that increases information and system interoperability, openness, and safeguarding – mutually reinforcing activities that help to promote data discoverability and usability. NIEM, as a government-wide program provides tools to enhance the way many communities build standardized exchanges to increase mission performance. NIEM fully aligns to the DGS/ODP policy and can be seen one of the tools for implementation.
191+
Each of these initiatives has a discreet, targeted focus, but all are aimed at increasing access and use of government data. Data.gov has provided a central place to find data and applications for publicly releasable information. New applications and services to better serve citizens have been produced as a result in the increase of information made available through Data.gov. The DGS/ODP policy establishes a framework to help institutionalize the principles of effective information management at each stage of the information's life cycle. The framework can help agencies build information systems and processes in a way that increases information and system interoperability, openness, and safeguarding – mutually reinforcing activities that help to promote data discoverability and usability. NIEM, as a government-wide program provides tools to enhance the way many communities build standardized exchanges to increase mission performance. NIEM fully aligns to the DGS/ODP policy and can be seen one of the tools for implementation.
192192

193193
### What is NIEM?
194194

Diff for: future-case-study.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@ Under a presidentially mandated deadline, Agency was tasked with providing the c
2121
## Approach
2222
The Project Open Data toolkit provided a pair of turnkey tools that made it trivial to accomplish the goals of the project. The “CSV to API” tool, available both for download and as a GSA-hosted web service, acted as a proxy through which any of the CSV files could be requested and automatically converted into JSON, XML, or HTML. By choosing the GSA-hosted version, no installation or configuration was required. The link to each CSV file was duplicated and prepended with the request to the GSA’s server, and the resulting URL advertised as the API endpoint.
2323

24-
Providing API-based access to the databases was a likewise straightforward process. The toolkit’s “DB to API” program was copied onto the web server (consisting of just a few files), and the configuration file was edited to be given access to each of the three databases. Because two of the databases contained columns that contained personally identifiable information (PII), the configuration file was instructed to prohibit access to those columns. Each database’s resulting API endpoint was listed on the website, with query parameters providing the data as JSON, XML, and HTML, depending on the requestor’s preference.
24+
Providing API-based access to the databases was a likewise straightforward process. The toolkit’s “DB to API” program was copied onto the web server (consisting of just a few files), and the configuration file was edited to be given access to each of the three databases. Because two of the databases contained columns that contained personally identifiable information (PII), the configuration file was instructed to prohibit access to those columns. Each database’s resulting API endpoint was listed on the website, with query parameters providing the data as JSON, XML, and HTML, depending on the requester’s preference.
2525

2626
## Results
2727
Providing their data as an API allowed it to be shared in new and interesting ways that Agency had not foreseen. Developers within Agency found that the data could be useful elsewhere on their website and within their internal workflow, and are using it experimentally for those purposes. Two other agencies are making calls from their websites to four of the CSV-based APIs and one of the database APIs, in order to provide an improved experience for their customers. One of the database APIs is being used by a private developer, who has created an iPhone app to make Agency’s data available to mobile users, prompting the agency to evaluate which other datasets might have commercial value.
2828

2929
## Lessons Learned
3030
* Providing an API for existing bulk download data and databases no longer presents a technical challenge.
31-
* Interagency collaboration is facilitated by adherence to common data exchange formats, and JSON and XML fill that role nicely.
31+
* Inter-agency collaboration is facilitated by adherence to common data exchange formats, and JSON and XML fill that role nicely.
3232
* The provision of an API allowed Agency to have improved access to their own data, enhancing internal data sharing practices and their overall workflow.
3333
* The private sector can meet demand that agencies cannot when given access to agencies’ APIs.
3434

Diff for: glossary.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ A simple text format for a database table. Each record in the table is one line
179179

180180
### Unstructured Data
181181

182-
Data that is more free-form, such as multimedia files, images, sound files, or unstructured text. Unstructured data does not necessarily follow any format or hierarchical sequence, nor does it follow any relational rules. Unstructured data refers to masses of (usually) computerized information which do not have a data structure which is easily readable by a machine. Examples of unstructured data may include audio, video and unstructured text such as the body of an email or word processor document. Data mining techniques are used to find patterns in, or otherwise interpret, this information. Merrill Lynch estimates that more than 85 percent of all business information exists as unstructured data – commonly appearing in e-mails, memos, notes fromcall centers and support operations, news, user groups, chats, reports, letters, surveys, white papers, marketing material, research, presentations, and Web pages (“The Problem with Unstructured Data.”) —*[source](http://www.whitehouse.gov/sites/default/files/omb/assets/egov_docs/DRM_2_0_Final.pdf)*
182+
Data that is more free-form, such as multimedia files, images, sound files, or unstructured text. Unstructured data does not necessarily follow any format or hierarchical sequence, nor does it follow any relational rules. Unstructured data refers to masses of (usually) computerized information which do not have a data structure which is easily readable by a machine. Examples of unstructured data may include audio, video and unstructured text such as the body of an email or word processor document. Data mining techniques are used to find patterns in, or otherwise interpret, this information. Merrill Lynch estimates that more than 85 percent of all business information exists as unstructured data – commonly appearing in e-mails, memos, notes from call centers and support operations, news, user groups, chats, reports, letters, surveys, white papers, marketing material, research, presentations, and Web pages (“The Problem with Unstructured Data.”) —*[source](http://www.whitehouse.gov/sites/default/files/omb/assets/egov_docs/DRM_2_0_Final.pdf)*
183183

184184
### Web Service
185185

Diff for: index.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -70,19 +70,19 @@ This section is a list of ready-to-use solutions or tools that will help agencie
7070

7171
4-9 [CFPB Project Qu](https://github.com/cfpb/qu) - The CFPB's in-progress data publishing platform, created to serve public data sets.
7272

73-
5-0 [HMDA Tools](http://https://github.com/cfpb/hmda-tools) - Lightweight tools to make importing and analyzing [Home Mortgage Disclosure Act](http://en.wikipedia.org/wiki/Home_Mortgage_Disclosure_Act) data easier.
73+
4-10 [HMDA Tools](http://https://github.com/cfpb/hmda-tools) - Lightweight tools to make importing and analyzing [Home Mortgage Disclosure Act](http://en.wikipedia.org/wiki/Home_Mortgage_Disclosure_Act) data easier.
7474

75-
4-9 [ESRI2Open](http://github.com/project-open-data/esri2open) - A tool which converts spatial and non-spatial data form ESRI only formats to the Open Data formats, CSV, Json, or GeoJSON, making them more a part of the www ecology.
75+
4-11 [ESRI2Open](http://github.com/project-open-data/esri2open) - A tool which converts spatial and non-spatial data form ESRI only formats to the Open Data formats, CSV, JSON, or GeoJSON, making them more a part of the WWW ecology.
7676

77-
4-10 [ckanext-datajson](https://github.com/HHS/ckanext-datajson) - A CKAN extension to generate agency.gov/data.json catalog files.
77+
4-12 [ckanext-datajson](https://github.com/HHS/ckanext-datajson) - A CKAN extension to generate agency.gov/data.json catalog files.
7878

79-
4-10 [DKAN](http://drupal.org/project/dkan) - An open data portal modeled on [CKAN](http://ckan.org/). DKAN is a stand alone Drupal distribution that allows anyone to spin up an open data portal in minutes as well as two modules, [DKAN Dataset](http://drupal.org/project/dkan_dataset) and [DKAN Datastore](http://drupal.org/project/dkan_datastore), that can be added to existing Drupal sites to add data portal functionality to an exist Drupal site.
79+
4-13 [DKAN](http://drupal.org/project/dkan) - An open data portal modeled on [CKAN](http://ckan.org/). DKAN is a stand alone Drupal distribution that allows anyone to spin up an open data portal in minutes as well as two modules, [DKAN Dataset](http://drupal.org/project/dkan_dataset) and [DKAN Datastore](http://drupal.org/project/dkan_datastore), that can be added to existing Drupal sites to add data portal functionality to an exist Drupal site.
8080

8181
----------------
8282

8383
##5. Resources
8484

85-
This section contains programatic tools, resources, and/or checklists to help programs determine open data requirements.
85+
This section contains programmatic tools, resources, and/or checklists to help programs determine open data requirements.
8686

8787
5-1 [Metadata Resources](metadata-resources/) -
8888
Resources to provide guidance and assistance for each aspect of creating and maintaining agency.gov/data catalog files.

Diff for: license-examples.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ Data and content created by government employees within the scope of their emplo
2222
* [Creative Commons CC0](http://creativecommons.org/choose/)
2323

2424
## More Information
25-
*[Extended list of comformant licenses](http://opendefinition.org/licenses/)*
25+
*[Extended list of conformant licenses](http://opendefinition.org/licenses/)*

0 commit comments

Comments
 (0)