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

Commit ef7d9d4

Browse files
author
James McKinney
committed
Fix FAQ links, and have consistent ending slash on schema links
1 parent 1db83b6 commit ef7d9d4

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
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/)
66

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

implementation-guide.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This listing can be maintained in a Data Management System (DMS) such as the ope
2323
* Develop and communicate a clear path for listing newly created or acquired datasets into the enterprise data inventory.
2424
* 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.
2525
* 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.
26-
* 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.
26+
* 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.
2727
* 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.
2828

2929

@@ -51,15 +51,15 @@ 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](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.
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.
5858
* 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.
5959

6060
### D) Resources
6161

62-
* [Common Core Metadata](/schema)
62+
* [Common Core Metadata](/schema/)
6363

6464

6565
## 3) Engage with customers to help facilitate and prioritize data release
@@ -132,7 +132,7 @@ Collect or create information (data) in a way that supports downstream informati
132132

133133
* Collect data electronically whenever possible.
134134
* Choose or build data collections tool that:
135-
- Export data in machine-readable formats. Consult [this list](faq.md) for suggested machine-readable formats.
135+
- Export data in machine-readable formats. Consult [this list](/faq/) for suggested machine-readable formats.
136136
- Use existing open data standards, if available.
137137
* 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.
138138
* 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.
@@ -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/) 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

0 commit comments

Comments
 (0)