Skip to content

Commit 60f3d36

Browse files
author
James McKinney
committed
Fix ALL the typos
1 parent 26b771a commit 60f3d36

22 files changed

+83
-83
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
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.md)
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.md)
66

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

api-basics.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -74,26 +74,26 @@ REST with JSON has become the favorite of developers and API owners, because it
7474

7575
### When Things Go Wrong — Error Handling
7676

77-
One of the most important issues to remember in API strategy is, developers need to handle what happens when an error occurs; otherwise, access to data fails and subsequently so does the application. For the purposes of the service framework, an error is defined as an unexpected behavior that occurred during the process of a request. It's important to note that what might be considered an "error" can often be an expected behavior.
77+
One of the most important issues to remember in API strategy is, developers need to handle what happens when an error occurs; otherwise, access to data fails and subsequently so does the application. For the purposes of the service framework, an error is defined as an unexpected behavior that occurred during the process of a request. Its important to note that what might be considered an "error" can often be an expected behavior.
7878
For instance, a search operation returning no results (a blank object) and an HTTP status 200 OK code might be construed as an error, but in reality this is not outside the realm of expected normal operation.
7979

8080
So really when we say errors we mean bad things happen like a database server goes down or a required parameter wasn't passed to a URI. Ultimately it is the responsibility of your code to anticipate and appropriately handle errors.
8181

8282
### Developing an API Ecosystem
8383

84-
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.
84+
An API starts with the desire to share data or resources that a company offers. Its 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.
8585

86-
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?
86+
An API and its supporting developer area are created. And then, whats next? How does a simple API area build community? How does it evolve into a thriving ecosystem like Facebook’s or Foursquares?
8787

8888
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.
8989

90-
An API owner has to support its API's community, be proactive about reaching out to its community and know what it needs.
90+
An API owner has to support its APIs community, be proactive about reaching out to its community and know what it needs.
9191

9292
Resources for developers need to be abundant and well organized. Common resources like blogs, forum, and FAQs are necessary. Tutorials, case studies and "How To’s" can take things even further.
9393

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

96-
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.
96+
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.
9797

9898
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.
9999

business-case.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ Making data open and accessible in a standard, machine-readable format by defaul
1010

1111
**Save time and money responding to Freedom of Information Act (FOIA) requests.** When data is open by default, the public can access the information it seeks directly, freeing your agency from the time and cost expenditures related to responding to FOIAs.
1212

13-
**Avoid duplicative internal research.** Transparency into the total universe of data held by your agency helps prevent the possibility of wasting funds re-collecting data simply because a particular program or department is unaware of that data's existence. Further, it may be possible to reduce the scope and cost of new collections based on the ability to re-use and/or pair with existing data. Maintaining a central data catalog for your agency makes it easier to understand what information is currently available, and reviewing this catalog prior to the start of any new data collection is a recommended best practice.
13+
**Avoid duplicative internal research.** Transparency into the total universe of data held by your agency helps prevent the possibility of wasting funds re-collecting data simply because a particular program or department is unaware of that datas existence. Further, it may be possible to reduce the scope and cost of new collections based on the ability to re-use and/or pair with existing data. Maintaining a central data catalog for your agency makes it easier to understand what information is currently available, and reviewing this catalog prior to the start of any new data collection is a recommended best practice.
1414

15-
**Discover complementary datasets held by other agencies.** The benefits of transparency into your agency's own datasets are amplified when every agency maintains its own standardized data catalog. Programs may realize that some or all of the data they need are already held by one or more other agencies, or that more powerful conclusions can be drawn from combining existing agency-held datasets with additional data across other agencies.
15+
**Discover complementary datasets held by other agencies.** The benefits of transparency into your agencys own datasets are amplified when every agency maintains its own standardized data catalog. Programs may realize that some or all of the data they need are already held by one or more other agencies, or that more powerful conclusions can be drawn from combining existing agency-held datasets with additional data across other agencies.
1616

17-
**Empower employees to make better-informed, data-driven decisions.** The new requirement to publish details about each dataset owned by your agency in a specific format will power a central search engine at [Data.gov](http://www.data.gov) that every single Federal employee (and member of the public) can use to easily locate data held, owned, and/or created by the Federal Government. Making it easier to find existing data is key to being able to then incorporate that data into your agency's everyday decision-making processes.
17+
**Empower employees to make better-informed, data-driven decisions.** The new requirement to publish details about each dataset owned by your agency in a specific format will power a central search engine at [Data.gov](http://www.data.gov) that every single Federal employee (and member of the public) can use to easily locate data held, owned, and/or created by the Federal Government. Making it easier to find existing data is key to being able to then incorporate that data into your agencys everyday decision-making processes.
1818

19-
**Positive attention from the public, media, and other agencies.** In recent years, [entire events](http://energy.gov/articles/energy-datapalooza-unleashing-power-open-data-advance-our-energy-future) [celebrating](http://www.ed.gov/blog/2013/01/education-datapalooza-unleashing-the-power-of-open-data-to-help-students-parents-and-teachers/) the release and use of open government data -- many hosted by the White House -- have taken place, with corresponding media coverage and international attention. The more data your agency makes available in easy-to-consume formats, the more opportunities for positive coverage of the availability and impact of those data and your agency's efforts.
19+
**Positive attention from the public, media, and other agencies.** In recent years, [entire events](http://energy.gov/articles/energy-datapalooza-unleashing-power-open-data-advance-our-energy-future) [celebrating](http://www.ed.gov/blog/2013/01/education-datapalooza-unleashing-the-power-of-open-data-to-help-students-parents-and-teachers/) the release and use of open government data -- many hosted by the White House -- have taken place, with corresponding media coverage and international attention. The more data your agency makes available in easy-to-consume formats, the more opportunities for positive coverage of the availability and impact of those data and your agencys efforts.
2020

21-
**Generate revenue and create new jobs in the private sector.** McKinsey estimates that open health data alone adds over $300 billion to the economy each year. Entrepreneurs and non-profits integrate existing open government datasets in ways ranging from iPhone apps that connect you with the nearest hospital in case of an emergency, with [information](http://www.healthdata.gov/question/what-types-applications-have-been-developed-using-healthdatagov-data) from Health and Human Services, to matching prospective college students with the most appropriate schools, based on [IPEDS](http://nces.ed.gov/ipeds/) data maintained by the Department of Education. Making more of your agency data publicly available in standards-compliant, machine-readable formats makes it easier for private sector companies and entrepreneurs to create new innovations fueled by your agency's data.
21+
**Generate revenue and create new jobs in the private sector.** McKinsey estimates that open health data alone adds over $300 billion to the economy each year. Entrepreneurs and non-profits integrate existing open government datasets in ways ranging from iPhone apps that connect you with the nearest hospital in case of an emergency, with [information](http://www.healthdata.gov/question/what-types-applications-have-been-developed-using-healthdatagov-data) from Health and Human Services, to matching prospective college students with the most appropriate schools, based on [IPEDS](http://nces.ed.gov/ipeds/) data maintained by the Department of Education. Making more of your agency data publicly available in standards-compliant, machine-readable formats makes it easier for private sector companies and entrepreneurs to create new innovations fueled by your agencys data.

catalog.md

Lines changed: 2 additions & 2 deletions
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 sites 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

cdo-position-description.md

Lines changed: 3 additions & 3 deletions
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

digital-pii-checklist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ filename: digital-pii-checklist.md
77

88
PII, also known as “personally identifiable Information,” is data potentially linked or linkable to individuals. The Digital PII Checklist identifies some common types of potential PII that may be collected, maintained, shared, or used in the mobile and digital environment. Agencies may use it as a baseline to ensure they have identified all data that may constitute PII prior to data release.
99

10-
For the checklist as well as additional information, see the CIO Council's [full report on Standardized Digital Privacy Controls](https://cio.gov/wp-content/uploads/downloads/2012/12/Standardized_Digital_Privacy_Controls.pdf).
10+
For the checklist as well as additional information, see the CIO Councils [full report on Standardized Digital Privacy Controls](https://cio.gov/wp-content/uploads/downloads/2012/12/Standardized_Digital_Privacy_Controls.pdf).

0 commit comments

Comments
 (0)