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

Fix links #45

Merged
merged 8 commits into from
May 17, 2013
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## How to Contribute

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)
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/)

Contributions can be made, primarily in two ways:

Expand Down Expand Up @@ -40,8 +40,8 @@ Project Open Data runs on GitHub pages and automatically regenerates as a static

## Licensing

By contributing to this project, you grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users under [the same terms under which the project is licensed](readme.md#licensing).
By contributing to this project, you grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users under [the same terms under which the project is licensed](README.md#licensing).

## Privacy

All comments, messages, pull requests, and other submissions received through official White House pages including this GitHub page may be subject to archiving requirements. See the [readme](readme.md#privacy) for more information.
All comments, messages, pull requests, and other submissions received through official White House pages including this GitHub page may be subject to archiving requirements. See the [readme](README.md#privacy) for more information.
6 changes: 4 additions & 2 deletions api-basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,10 @@ APIs are driven by a set of specific technologies, making them easily understood

Since REST takes advantage of the same Internet mechanisms that are used to view regular web pages it has many advantages, resulting in faster implementations and easier for developers to understand. REST APIs allow you to take data and functionality available on your website and make these resources available through a Web API. Then, instead of returning HTML to represent these resources, the API returns data in one of two possible formats:

* [Extensible Markup Language (XML)](http://apievangelist.com/buildingblocks/extensible_markup_language_(xml)
* [JavaScript Object Notation (JSON)](http://apievangelist.com/buildingblocks/javascript_object_notation_(json)
<ul>
<li><a href="http://apievangelist.com/buildingblocks/extensible_markup_language_(xml).php">Extensible Markup Language (XML)</a></li>
<li><a href="http://apievangelist.com/buildingblocks/javascript_object_notation_(json).php">JavaScript Object Notation (JSON)</a></li>
</ul>

Developers can then take this data and use in web and mobile applications. However XML and JSON are easily consumed by spreadsheets and other tools non-developers can use as well, making APIs accessible by anyone.

Expand Down
2 changes: 1 addition & 1 deletion glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ A standard developed or adopted by voluntary consensus standards bodies, both do

### Parameter

A special kind of variable, used in a subroutine to refer to one of the pieces of data provided as input to the subroutine. The semantics for how parameters can be declared and how the arguments get passed to the parameters of subroutines are defined by the language, but the details of how this is represented in any particular computer system depend on the calling conventions of that system. —*[source](http://en.wikipedia.org/wiki/Parameter_(computer_science))*
A special kind of variable, used in a subroutine to refer to one of the pieces of data provided as input to the subroutine. The semantics for how parameters can be declared and how the arguments get passed to the parameters of subroutines are defined by the language, but the details of how this is represented in any particular computer system depend on the calling conventions of that system. —*<a href="http://en.wikipedia.org/wiki/Parameter_(computer_science)">source</a>*

### RDF

Expand Down
22 changes: 11 additions & 11 deletions implementation-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ filename: implementation-guide.md


## 1) Create and maintain an enterprise data inventory
*[Due by 11/9/13]*
*\[Due by 11/9/13\]*

Maintain a complete listing of all datasets owned, managed, collected, and/or created by your agency, described in a common format.

Expand All @@ -23,12 +23,12 @@ This listing can be maintained in a Data Management System (DMS) such as the ope
* Develop and communicate a clear path for listing newly created or acquired datasets into the enterprise data inventory.
* The more employees who can contribute to the enterprise data inventory, whether by submitting feedback or by actually being able to log in and update listings in the agency DMS, the more accurate and complete your metadata will be.
* While it may initially seem that maintaining your agency data inventory in a single spreadsheet is the simplest solution, this is often not the case. A central spreadsheet is difficult for more than one person to maintain, easily leading to errors and omissions.
* In addition to the required [common core metadata](/schema), work with your agency and topical experts to develop an expanded set of metadata fields that make sense for your vertical. Many already exist; explore [Schema.org](http://www.schema.org) as a starting point.
* In addition to the required [common core metadata](/schema/), work with your agency and topical experts to develop an expanded set of metadata fields that make sense for your vertical. Many already exist; explore [Schema.org](http://www.schema.org) as a starting point.
* Your agency can and should use this central inventory listing as an internal search tool to increase awareness of data collections already in existence and to prevent duplicative research efforts. For example, a search of this inventory may reveal that the combination of two existing datasets could produce the results sought by a proposed new collection.


## 2) Create and maintain a public data inventory
*[Due by 11/9/13]*
*\[Due by 11/9/13\]*

Maintain a publicly accessible listing of all datasets maintained by your agency for harvesting by a central Data.gov search engine and the public at large.

Expand All @@ -38,7 +38,7 @@ While agencies are only required to list datasets with an "Access Level" value o

Document any datasets or metadata in your enterprise data inventory that your agency does not believe can be made publicly available, in consultation with your Office of General Counsel or its equivalent.

Publish your agency’s enterprise data inventory, with the aforementioned information removed, to a file located at [agency].gov/data.json and described using (at minimum) the [common core metadata](http://project-open-data.github.io/schema/). This file itself must be listed as a dataset within itself (see [an example of format](http://project-open-data.github.io/examples/catalog-sample-extended.json) ); if you have multiple data.json files across your agency, include all of them in the top-level data.json at agency.gov/data.json.
Publish your agency’s enterprise data inventory, with the aforementioned information removed, to a file located at \[agency\].gov/data.json and described using (at minimum) the [common core metadata](http://project-open-data.github.io/schema/). This file itself must be listed as a dataset within itself (see [an example of format](http://project-open-data.github.io/examples/catalog-sample-extended.json) ); if you have multiple data.json files across your agency, include all of them in the top-level data.json at agency.gov/data.json.

While you could manually create this file in a text editor, it is recommended that you use one of the tools provided to generate this file automatically from your existing DMS or enterprise inventory file.

Expand All @@ -51,19 +51,19 @@ While you could manually create this file in a text editor, it is recommended th

### C) Best Practices and Examples

* Using the [common core metadata](http://project-open-data.github.io/schema) to describe your enterprise data inventory makes it very simple to use that inventory for your public inventory.
* Using the [common core metadata](http://project-open-data.github.io/schema/) to describe your enterprise data inventory makes it very simple to use that inventory for your public inventory.
* A detailed and descriptive title, description, and set of keywords for each dataset is the difference between customers finding your data and no one finding your data. Since agency data catalogs are harvested and searchable on Data.gov, accurate and thorough metadata is the best way to connect customers with your data.
* Consider including restricted and non-public datasets in your public data inventory listing. Remember that this file contains metadata about the data and not the data themselves.
* When you include restricted datasets in your public data inventory, include specific information on how customers can request and qualify for access to those data.
* Integrate your public data inventory with a tool for soliciting feedback from customers to avoid duplicative effort. For example, the [Kickstart WordPress plugin](https://github.com/project-open-data/kickstart) can automatically generate a voting and commenting mechanism from your data.json file.

### D) Resources

* [Common Core Metadata](/schema)
* [Common Core Metadata](/schema/)


## 3) Engage with customers to help facilitate and prioritize data release
*[Due by 11/9/13]*
*\[Due by 11/9/13\]*

### Minimum Required for Compliance

Expand All @@ -82,7 +82,7 @@ Create a process to solicit feedback from customers about existing and potential


## 4) Clarify Roles and Responsibilities
*[Due by 11/9/13]*
*\[Due by 11/9/13\]*

### A) Minimum Required for Compliance

Expand Down Expand Up @@ -119,7 +119,7 @@ Additionally, you should include information on:

* [44 USC 3506 (b)(2)](http://www.gpo.gov/fdsys/granule/USCODE-2011-title44/USCODE-2011-title44-chap35-subchapI-sec3506/content-detail.html)
* [OMB Circular A-11](http://www.whitehouse.gov/omb/circulars_a11_current_year_a11_toc)
* [OMB FY 13 PortfolioStat Guidance] (http://www.whitehouse.gov/blog/2013/03/27/portfoliostat-20-driving-better-management-and-efficiency-federal-it)
* [OMB FY 13 PortfolioStat Guidance](http://www.whitehouse.gov/blog/2013/03/27/portfoliostat-20-driving-better-management-and-efficiency-federal-it)

<center><h2><u>Ongoing</u></h2></center>

Expand All @@ -132,7 +132,7 @@ Collect or create information (data) in a way that supports downstream informati

* Collect data electronically whenever possible.
* Choose or build data collections tool that:
- Export data in machine-readable formats. Consult [this list](faq.md) for suggested machine-readable formats.
- Export data in machine-readable formats. Consult [this list](/faq/) for suggested machine-readable formats.
- Use existing open data standards, if available.
* Apply an open license, in consultation with best practices, to information as it is collected or created so that if data are made public there are no restrictions on the use or re-use of these data.
* Collect the minimum amount of data needed to achieve your stated goals, in order to avoid having to remove additional personally-identifiable information later in the collection or release process.
Expand Down Expand Up @@ -163,7 +163,7 @@ Collect or create information (data) in a way that supports downstream informati
### A) Minimum Required for Compliance

* Review information for privacy, confidentiality pledge, security, and other restrictions to release.
* Make the data available in a machine-readable format. See [this list](http://project-open-data.github.io/faq.md) of commonly accepted machine-readable formats. Where appropriate, provide access to the data via an API.
* Make the data available in a machine-readable format. See [this list](/faq/) of commonly accepted machine-readable formats. Where appropriate, provide access to the data via an API.
* Post the data files in an Internet-accessible location, listing this location the dataset’s entry in your agency inventory listing.

### B) Tools
Expand Down
10 changes: 5 additions & 5 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,13 @@ This section is a list of definitions and principles used to guide the project.

Implementation guidance for open data practices.

3-1 [U.S. Government Policy on Open Data](policy-memo/) - Full text of the memorandum.
3-1 [U.S. Government Policy on Open Data](/policy-memo/) - Full text of the memorandum.

3-2 [Implementation Guide](implementation-guide/) - Detailed descriptions and guidance for each step of implementing the policy.
3-2 [Implementation Guide](/implementation-guide/) - Detailed descriptions and guidance for each step of implementing the policy.

3-3 [Public Data Listing](catalog) - The specific guidance for publishing the Open Data Catalog at the agency.gov/data page.
3-3 [Public Data Listing](/catalog/) - The specific guidance for publishing the Open Data Catalog at the agency.gov/data page.

3-4 [Frequently Asked Questions](faq) - A growing list of common questions and answers to facilitate adoption of open data projects.
3-4 [Frequently Asked Questions](/faq/) - A growing list of common questions and answers to facilitate adoption of open data projects.

----------------

Expand Down Expand Up @@ -111,7 +111,7 @@ Case studies of novel or best practices from agencies who are leading in open da

6-7 [National Renewable Energy Laboratory API program](http://developer.nrel.gov/api-case-study/) - An agency perspective on developing APIs for general use and in particular building the case for the internal re-use of the resources.

6-8 [USAID Crowdsourcing to Open Data] (http://transition.usaid.gov/our_work/economic_growth_and_trade/development_credit/pdfs/2012/USAIDCrowdsourcingCaseStudy.pdf) - A case study that shows how USAID invited the "crowd" to clean and geocode a USAID dataset in order to open and map the data.
6-8 [USAID Crowdsourcing to Open Data](http://transition.usaid.gov/our_work/economic_growth_and_trade/development_credit/pdfs/2012/USAIDCrowdsourcingCaseStudy.pdf) - A case study that shows how USAID invited the "crowd" to clean and geocode a USAID dataset in order to open and map the data.


**For Developers: [View all appendices](http://github.com/project-open-data/) (and source)**
2 changes: 1 addition & 1 deletion metadata-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ permalink: /metadata-resources/
filename: metadata-resources.md
---

This section provides further background and resources to assist agencies in implementing the [common core metadata schema](schema/).
This section provides further background and resources to assist agencies in implementing the [common core metadata schema](/schema/).

### Template Data Files

Expand Down
Loading