You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 18, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
## How to Contribute
4
4
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/)
Copy file name to clipboardExpand all lines: implementation-guide.md
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ This listing can be maintained in a Data Management System (DMS) such as the ope
23
23
* Develop and communicate a clear path for listing newly created or acquired datasets into the enterprise data inventory.
24
24
* 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.
25
25
* 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.
27
27
* 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.
28
28
29
29
@@ -51,15 +51,15 @@ While you could manually create this file in a text editor, it is recommended th
51
51
52
52
### C) Best Practices and Examples
53
53
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.
55
55
* 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.
56
56
* 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.
57
57
* 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.
58
58
* 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.
59
59
60
60
### D) Resources
61
61
62
-
*[Common Core Metadata](/schema)
62
+
*[Common Core Metadata](/schema/)
63
63
64
64
65
65
## 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
132
132
133
133
* Collect data electronically whenever possible.
134
134
* 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.
136
136
- Use existing open data standards, if available.
137
137
* 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.
138
138
* 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
163
163
### A) Minimum Required for Compliance
164
164
165
165
* 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.
167
167
* Post the data files in an Internet-accessible location, listing this location the dataset’s entry in your agency inventory listing.
0 commit comments