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

Commit f6e4497

Browse files
author
James McKinney
committed
Change URLs to not include http://project-open-data.github.io (just use e.g. /schema/)
1 parent 26b771a commit f6e4497

File tree

6 files changed

+27
-27
lines changed

6 files changed

+27
-27
lines changed

Diff for: catalog.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This section provides further guidance and explanation for implementing the agen
1010
/Data Requirements
1111
------------------
1212

13-
The Open Data Policy requires agencies to list and describe all agency data that *can* be made publicly available (i.e. there are no valid restrictions to release) in a publicly available open data catalog with [common core metadata](http://project-open-data.github.io/schema/). It further requires the catalog to be human-readable and machine-readable. This guidance describes to agencies steps for implementing this portion of the policy.
13+
The Open Data Policy requires agencies to list and describe all agency data that *can* be made publicly available (i.e. there are no valid restrictions to release) in a publicly available open data catalog with [common core metadata](/schema/). It further requires the catalog to be human-readable and machine-readable. This guidance describes to agencies steps for implementing this portion of the policy.
1414

1515
Why this effort
1616
---------------
@@ -26,12 +26,12 @@ Each agency will describe their existing datasets as they see fit using the belo
2626
Machine-Readable Format
2727
-----------------------
2828

29-
All information deemed "machine-readable" required in this policy must be described in the JSON file format, with the option of RDFa Lite and XML as well. See [this specification](http://project-open-data.github.io/schema/) for the required schema. Agencies must post their files at agency.gov/data.json (and optionally at /data.html or data.xml as well). Additionally, the web page which reads and formats these files must be posted at /data/index.html (or data.html). The files should be updated a minimum of monthly. It is our intent that future publications of Data.gov will simply crawl for all agency.gov/data.json to populate Data.gov.
29+
All information deemed "machine-readable" required in this policy must be described in the JSON file format, with the option of RDFa Lite and XML as well. See [this specification](/schema/) for the required schema. Agencies must post their files at agency.gov/data.json (and optionally at /data.html or data.xml as well). Additionally, the web page which reads and formats these files must be posted at /data/index.html (or data.html). The files should be updated a minimum of monthly. It is our intent that future publications of Data.gov will simply crawl for all agency.gov/data.json to populate Data.gov.
3030

3131
Implementing
3232
------------
3333

34-
To fulfill the requirements of this memorandum, agencies should begin to describe datasets as a catalog using the vocabulary of the [common core metadata](http://project-open-data.github.io/schema/). This catalog is to be published in two places. First, as a standalone JSON file at `agency.gov/data.json` and second with RDFa Lite, either embedded within a HTML page which include human readable markups (e.g., `agency.gov/data.html`) or as an XML file (e.g., `agency.gov/data.xml`).
34+
To fulfill the requirements of this memorandum, agencies should begin to describe datasets as a catalog using the vocabulary of the [common core metadata](/schema/). This catalog is to be published in two places. First, as a standalone JSON file at `agency.gov/data.json` and second with RDFa Lite, either embedded within a HTML page which include human readable markups (e.g., `agency.gov/data.html`) or as an XML file (e.g., `agency.gov/data.xml`).
3535

3636
### JSON
3737

@@ -47,7 +47,7 @@ The JSON representation of the catalog should track directly to the RDFa version
4747
Generating Machine-Readable Reporting Files
4848
-------------------------------------------
4949

50-
Agencies must follow the provided [specification](http://project-open-data.github.io/schema/). We have built a [catalog generator](http://project-open-data.github.com/catalog-generator/) to assist you in building your catalog and generating JSON, XML, or RDFa Lite files.
50+
Agencies must follow the provided [specification](/schema/). We have built a [catalog generator](http://project-open-data.github.com/catalog-generator/) to assist you in building your catalog and generating JSON, XML, or RDFa Lite files.
5151

5252
Presentation
5353
------------
@@ -58,7 +58,7 @@ Agencies must have present a table/list of each dataset in the /data page. The
5858
* Dataset description
5959
* URL to the dataset (endpoint)
6060

61-
The page must be populated from the machine-readable catalog file (e.g. data.xml or data.json) following the [specification](http://project-open-data.github.io/schema/) described above. Agencies are encouraged to add functionality to assist end-user discoverability. Additional functions might be sorting, filtering or paging to help make a more digestible list. Agencies are also encouraged to add more to the standard schema which might further assist end-user discoverability and usability (e.g. thumbnails).
61+
The page must be populated from the machine-readable catalog file (e.g. data.xml or data.json) following the [specification](/schema/) described above. Agencies are encouraged to add functionality to assist end-user discoverability. Additional functions might be sorting, filtering or paging to help make a more digestible list. Agencies are also encouraged to add more to the standard schema which might further assist end-user discoverability and usability (e.g. thumbnails).
6262

6363
Supplemental Information
6464
------------------------

Diff for: faq.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ While ISO 32000 is an open standard, the Portable Document Format (PDF) does not
9292

9393
### What is the relationship of the metadata standard (specifically) to NIEM, ISE, FGDC, and other existing (especially official) government data standards?
9494

95-
The [common core metadata schema](http://project-open-data.github.io/schema/) is based on existing vocabularies and easily mapped to NIEM, Information Sharing Environment, and FGDC.
95+
The [common core metadata schema](/schema/) is based on existing vocabularies and easily mapped to NIEM, Information Sharing Environment, and FGDC.
9696

9797
### What is a "persistent identifier"?
9898

@@ -104,9 +104,9 @@ The core metadata schema was the result of recommendations from a government-wid
104104

105105
### How can I recommend changes and improvements to the metadata schema?
106106

107-
Submit a pull request for the [metadata schema](http://project-open-data.github.io/schema/).
107+
Submit a pull request for the [metadata schema](/schema/).
108108

109-
### Can I extend the metadata schema beyond the terms specified in the [common core metadata schema](http://project-open-data.github.io/schema/)?
109+
### Can I extend the metadata schema beyond the terms specified in the [common core metadata schema](/schema/)?
110110

111111
Yes, if your data management process includes rich metadata specific to the mission of your agency or the Line of Business your agency participates, publishing additional metadata that makes your data more useful to the public is welcomed and encouraged. Note that Data.gov will be harvesting only the metadata in this published schema unless specific arrangements are in place (e.g. geospatial FGDC/ISO).
112112

@@ -157,7 +157,7 @@ A wide variety of tools are available to manage a data catalog, whether public-f
157157

158158
### What formats are required/recommended for the agency.gov/data file?
159159

160-
There are several syntaxes that may be used when publishing the data file. The syntax that is required to make the data readily available to developers is JSON (JavaScript Object Notation). It is recommended that agencies also create a data.html file and use RDFa Lite (Resource Description Framework) to mark-up the metadata using the [common core metadata schema](http://project-open-data.github.io/schema/). The RDFa Lite file can be easily consumed by major search engines and applications and make you data easier to find by the public. A third alternative for populating your metadata file is XML (eXtensible Markup Language). Agencies are encouraged to maintain all three version of the metadata file. [Tools](http://labs.data.gov) are available to transform any instance of the file into the alternative formats.
160+
There are several syntaxes that may be used when publishing the data file. The syntax that is required to make the data readily available to developers is JSON (JavaScript Object Notation). It is recommended that agencies also create a data.html file and use RDFa Lite (Resource Description Framework) to mark-up the metadata using the [common core metadata schema](/schema/). The RDFa Lite file can be easily consumed by major search engines and applications and make you data easier to find by the public. A third alternative for populating your metadata file is XML (eXtensible Markup Language). Agencies are encouraged to maintain all three version of the metadata file. [Tools](http://labs.data.gov) are available to transform any instance of the file into the alternative formats.
161161

162162
## Agency participation with Open Data
163163

Diff for: governance.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ filename: governance.md
66
---
77

88
### Background
9-
[Project Open Data](http://project-open-data.github.com), a new White House resource, is an online collection of code, best practices, and case studies developed to help agencies adopt the framework presented in the memorandum on “Managing Government Information as an Asset to Promote Interoperability and Openness.” Project Open Data will evolve over time as a community resource to facilitate adoption of open data practices. To facilitate collaboration across the Federal Government and in partnership with public developers, the Project is published on the developer social network GitHub.
9+
[Project Open Data](/), a new White House resource, is an online collection of code, best practices, and case studies developed to help agencies adopt the framework presented in the memorandum on “Managing Government Information as an Asset to Promote Interoperability and Openness.” Project Open Data will evolve over time as a community resource to facilitate adoption of open data practices. To facilitate collaboration across the Federal Government and in partnership with public developers, the Project is published on the developer social network GitHub.
1010

1111
As the Project founder, the White House is dedicated to maximizing openness, participation, and collaboration while ensuring the integrity of the resources hosted within the Project. This page provides information on ways to participate in the Project and how the White House will govern it.
1212

@@ -40,7 +40,7 @@ Ultimately? You. While the White House founded and continues to oversee the proj
4040
At the onset, the General Services Administration is here to provide daily oversight and support, but over time, it is our vision that contributors both inside and outside of government can be empowered to take on additional leadership roles.
4141

4242
**Can I use the project's content or source code elsewhere?**
43-
The project [as originally published](http://project-open-data.github.io/) constitutes a work of the United States Government and is not subject to domestic copyright protection under 17 USC § 105. Subsequent contributions by members of the public, however, retain their original copyright.
43+
The project [as originally published](/) constitutes a work of the United States Government and is not subject to domestic copyright protection under 17 USC § 105. Subsequent contributions by members of the public, however, retain their original copyright.
4444
In order to better facilitate collaboration, the content of this project is licensed under the [Creative Commons 3.0 License](http://creativecommons.org/licenses/by/3.0/us/deed.en_US), and the underlying source code used to format and display that content is licensed under the [MIT License](http://opensource.org/licenses/mit-license.php).
4545

4646
**How can I contribute?**

Diff for: implementation-guide.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Maintain a complete listing of all datasets owned, managed, collected, and/or cr
1313

1414
### A) Minimum Required for Compliance
1515

16-
Produce a single catalog or list of data managed in a single table, workspace, or other relevant location. Describe each dataset according to the [common core metadata](http://project-open-data.github.io/schema/).
16+
Produce a single catalog or list of data managed in a single table, workspace, or other relevant location. Describe each dataset according to the [common core metadata](/schema/).
1717

1818
This listing can be maintained in a Data Management System (DMS) such as the open-source [CKAN](http://www.ckan.org) platform; a single spreadsheet, with each metadata field as its own column; or a DMS of your choosing.
1919

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

3939
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.
4040

41-
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.
41+
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](/schema/). This file itself must be listed as a dataset within itself (see [an example of format](/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.
4242

4343
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.
4444

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

5252
### C) Best Practices and Examples
5353

54-
* 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.
54+
* Using the [common core metadata](/schema) to describe your enterprise data inventory makes it very simple to use that inventory for your public inventory.
5555
* 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.
5656
* 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.
5757
* 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.
@@ -77,7 +77,7 @@ Create a process to solicit feedback from customers about existing and potential
7777

7878
### B) Best Practices and Examples
7979

80-
* The required set of [common core metadata](http://project-open-data.github.io/schema/) includes fields for a contact name (“person”) and an email address (“mbox”). Listing specific, accurate information in these fields for each dataset ensures that customers can give direct feedback on a dataset to the person who is most likely to be able to act on that feedback.
80+
* The required set of [common core metadata](/schema/) includes fields for a contact name (“person”) and an email address (“mbox”). Listing specific, accurate information in these fields for each dataset ensures that customers can give direct feedback on a dataset to the person who is most likely to be able to act on that feedback.
8181
* If you enable customers to leave comments on datasets, ensure someone at your agency monitors these comments and responds in a timely manner. When new visitors see outdated, unanswered comments, they are less likely to provide feedback.
8282

8383

@@ -163,7 +163,7 @@ Collect or create information (data) in a way that supports downstream informati
163163
### A) Minimum Required for Compliance
164164

165165
* Review information for privacy, confidentiality pledge, security, and other restrictions to release.
166-
* 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.
166+
* Make the data available in a machine-readable format. See [this list](/faq.md) of commonly accepted machine-readable formats. Where appropriate, provide access to the data via an API.
167167
* Post the data files in an Internet-accessible location, listing this location the dataset’s entry in your agency inventory listing.
168168

169169
### B) Tools
@@ -185,7 +185,7 @@ New, or significantly modified, information systems need to support interoperabi
185185

186186
* Ensure the system can export data in a machine-readable format.
187187
* Ensure data is separated from the application layer of the system to maximize future export and/or reuse of the data.
188-
* Store and export data using open data standards whenever possible, including the [common core metadata](http://project-open-data.github.io/schema/) required by this Memorandum.
188+
* Store and export data using open data standards whenever possible, including the [common core metadata](/schema/) required by this Memorandum.
189189
* Document all data schemas and dictionaries used by the system.
190190

191191
### B) Best Practices and Examples

Diff for: policy-memo.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ This attachment provides definitions and implementation guidance for M-13-13, *O
7676

7777
* *Managed Post-Release.* A point of contact must be designated to assist with data use and to respond to complaints about adherence to these open data requirements.
7878

79-
* *Project Open Data:* "Project Open Data," a new OMB and OSTP resource, is an online repository of tools, best practices, and schema to help agencies adopt the framework presented in this guidance. Project Open Data can be accessed at [project-open-data.github.io](http://project-open-data.github.io).[^18] Project Open Data will evolve over time as a community resource to facilitate adoption of open data practices. The repository includes definitions, code, checklists, case studies, and more, and enables collaboration across the Federal Government, in partnership with public developers, as applicable. Agencies can visit Project Open Data for a more comprehensive glossary of terms related to open data.
79+
* *Project Open Data:* "Project Open Data," a new OMB and OSTP resource, is an online repository of tools, best practices, and schema to help agencies adopt the framework presented in this guidance. Project Open Data can be accessed at [project-open-data.github.io](/).[^18] Project Open Data will evolve over time as a community resource to facilitate adoption of open data practices. The repository includes definitions, code, checklists, case studies, and more, and enables collaboration across the Federal Government, in partnership with public developers, as applicable. Agencies can visit Project Open Data for a more comprehensive glossary of terms related to open data.
8080

8181
### II. Scope
8282

0 commit comments

Comments
 (0)