From f9a1b5e40defb11c74da211beb9cfd1df391b3a3 Mon Sep 17 00:00:00 2001 From: Jacob Brady Date: Fri, 5 Mar 2021 00:37:51 -0500 Subject: [PATCH 1/2] Clean up document names and hyperlinks --- README.md | 2 +- create-feed/README.md | 2 +- ...> WZDx_Data_Feed_Self-Validation_Checklist.docx} | Bin ...ters Guide.pdf => WZDx_Early_Adopters_Guide.pdf} | Bin 4 files changed, 2 insertions(+), 2 deletions(-) rename documents/{WZDx data feed self validation checklist.docx => WZDx_Data_Feed_Self-Validation_Checklist.docx} (100%) rename documents/{WZDx Early Adopters Guide.pdf => WZDx_Early_Adopters_Guide.pdf} (100%) diff --git a/README.md b/README.md index ec0cd89e..b59b2470 100644 --- a/README.md +++ b/README.md @@ -120,7 +120,7 @@ Contact Information: [avdx@dot.gov](mailto:avdx@dot.gov?subject=Submission%20of% The WZDWG welcomes feedback and comments on the WZDx 3.0 Specification. Comments can be made by posting a GitHub [Issues](https://github.com/usdot-jpo-ode/jpo-wzdx/issues) or [Discussions](https://github.com/usdot-jpo-ode/jpo-wzdx/discussions), while suggested changes can be made using a [Pull Request](https://github.com/usdot-jpo-ode/jpo-wzdx/pulls). -1. Read about WZDWG activities [Wiki](https://github.com/usdot-jpo-ode/jpo-wzdx/wiki) and the [WZDx Early Adopter's Guide](https://github.com/usdot-jpo-ode/jpo-wzdx/blob/create_feed_updates/documents/WZDx%20Early%20Adopters%20Guide.pdf) +1. Read about WZDWG activities [Wiki](https://github.com/usdot-jpo-ode/jpo-wzdx/wiki) and the [WZDx Early Adopter's Guide](/documents/WZDx_Early_Adopters_Guide.pdf) 2. Learn about using GitHub as a [tool for collaboration and support](/create-feed/README.md#collaborate-via-github). 3. Use [Specification Content](/spec-content) page to understand the data components of the specification. 4. [Create your own feed](/create-feed) using example feeds and follow the business rules. diff --git a/create-feed/README.md b/create-feed/README.md index 1634cb54..74fede6d 100644 --- a/create-feed/README.md +++ b/create-feed/README.md @@ -65,7 +65,7 @@ Use the corresponding JSON schema linked above to validate WZDx v2.0 and v3.0 fe To validate data feeds and measure compliance with the v1.1 specification, the GSA/18F team have developed a prototype data validation tool. This validation service that checks work zone activities against the WZDx v1.1 JSON schema specification is available [here](https://github.com/18F/usdot-jpo-ode-workzone-data-exchange/wiki). ### Self-Validation Checklist -For a list of steps to take to make sure your data feed is ready to publish, follow the [Self-Validation Checklist](https://github.com/usdot-jpo-ode/jpo-wzdx/blob/create_feed_updates/documents/WZDx%20data%20feed%20self%20validation%20checklist.docx) +For a list of steps to take to make sure your data feed is ready to publish, follow the [Self-Validation Checklist](/documents/WZDx_Data_Feed_Self-Validation_Checklist.docx) ## Collaborate via GitHub GitHub is an open-source repository hosting service that allows for the storage and collaboration of data projects with version control (tracks changes and allows you to revert to previous iterations). The GitHub workflow is comprised of following steps: diff --git a/documents/WZDx data feed self validation checklist.docx b/documents/WZDx_Data_Feed_Self-Validation_Checklist.docx similarity index 100% rename from documents/WZDx data feed self validation checklist.docx rename to documents/WZDx_Data_Feed_Self-Validation_Checklist.docx diff --git a/documents/WZDx Early Adopters Guide.pdf b/documents/WZDx_Early_Adopters_Guide.pdf similarity index 100% rename from documents/WZDx Early Adopters Guide.pdf rename to documents/WZDx_Early_Adopters_Guide.pdf From 4e12156cbdfa10f525d96235f4d7c9f96c6d5c1b Mon Sep 17 00:00:00 2001 From: chuehlien Date: Thu, 25 Mar 2021 15:46:10 -0400 Subject: [PATCH 2/2] Scrub master branch references in READMEs --- README.md | 2 +- create-feed/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b59b2470..f17de559 100644 --- a/README.md +++ b/README.md @@ -124,7 +124,7 @@ The WZDWG welcomes feedback and comments on the WZDx 3.0 Specification. Comments 2. Learn about using GitHub as a [tool for collaboration and support](/create-feed/README.md#collaborate-via-github). 3. Use [Specification Content](/spec-content) page to understand the data components of the specification. 4. [Create your own feed](/create-feed) using example feeds and follow the business rules. -5. Validate your feed output using the [WZDx v3.0 Feed JSON Schema](https://github.com/usdot-jpo-ode/jpo-wzdx/blob/master/create-feed/schemas/wzdx_v3.0_feed.json) +5. Validate your feed output using the [WZDx v3.0 Feed JSON Schema](/create-feed/schemas/wzdx_v3.0_feed.json) 6. Publish your feed and tell us about it via avdx@dot.gov. # Contributions diff --git a/create-feed/README.md b/create-feed/README.md index 74fede6d..0bcfe06d 100644 --- a/create-feed/README.md +++ b/create-feed/README.md @@ -82,4 +82,4 @@ To start collaborating, [join GitHub](https://github.com/) by creating free [org ### How Do I Get Help? To interact directly with the DAVI Data Team and to get help implementing the spec for your data, post an **issue** under the **help wanted** label on the Work Zone GitHub site. -![Posting An Issue](https://github.com/usdot-jpo-ode/jpo-wzdx/blob/master/images/issues.png) +![Posting An Issue](/images/issues.png)