Skip to content

Commit e7f79e7

Browse files
AJKimpoKimpo72
andauthored
root folder README minor revisions (#643)
Co-authored-by: Anthony Kimpo <[email protected]>
1 parent 59d4f97 commit e7f79e7

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

README.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
# CDC Data Exchange (DEX) Upload
22

3-
The CDC Data Exchage (DEX) Upload API is an open-source service created to support public health Data Senders in their effort to share critical public health data with internal CDC Programs. The open-source model allows users to tailor the tool to fit specific data needs. <br/>
3+
The CDC Data Exchange (DEX) Upload API is an open-source service created to support public health data providers in their effort to share critical public health information with internal CDC Programs. The open-source model allows users to tailor the tool to fit specific data needs. <br/>
44

55
The Upload API service is a highly scalable, highly reliable means of transiting files of nearly any type and size from public health partners to the CDC, even when sent over unreliable network connections.
66

7-
87
## Upload Services
98

109
**Resumable Uploads**: Implementation of the Tus service as a library in a Golang application, facilitating high volume file uploads over HTTP.
@@ -15,7 +14,7 @@ The Upload API service is a highly scalable, highly reliable means of transiting
1514

1615
**File Delivery**: Routing of uploaded files to configured target destinations.
1716

18-
**File Observability**: Upload lifecycle event tracking and endpoints for health check, information, and application version.
17+
**File Observability**: Upload lifecycle event tracking, open telemetry traces and metrics, and endpoints for health check, information, and application version.
1918

2019
**Retry Delivery**: Tool that delivers files to target destinations that uploaded successfully, but were unsuccessful in delivery.
2120

@@ -42,37 +41,45 @@ Smoke test suites leveraging kotlin (`/smoke/kotlin`) and playwright (`/smoke/pl
4241
- [Kotlin Smoke Test README](https://github.com/CDCgov/data-exchange-upload/blob/main/tests/smoke/kotlin/README.md)
4342
- [Playwright Smoke Test README](https://github.com/CDCgov/data-exchange-upload/blob/main/tests/smoke/playwright/README.md)
4443

44+
Load testing tool enabling high volumes of file uploads (`/bad-uploader`).
45+
- [Load Testing Tool README](https://github.com/CDCgov/data-exchange-upload/blob/main/tests/bad-uploader/readme.md)
46+
4547
### upload-configs
4648

47-
Configuration files containing manifest schema values and routing delivery details for specific data stream use cases (`/v2`). The JSON configuration files are utilized to verify metadata accommpanying uploads and to determine file delivery to specified target locations.
49+
Configuration files containing manifest schema values and routing delivery details for specific data stream use cases. JSON configuration files are utilized to verify metadata accommpanying uploads and to determine file delivery to specified target locations.
4850
- [Upload Configs README](https://github.com/CDCgov/data-exchange-upload/blob/main/upload-configs/README.md)
4951

52+
### upload-reports
53+
54+
Go application that fetches data from the [Processing Status GraphQL API](https://github.com/CDCgov/data-exchange-processing-status), generates a CSV report, and optionally uploads it to S3.
55+
- [Upload Reports README](https://github.com/CDCgov/data-exchange-upload/blob/main/upload-reports/README.md)
56+
57+
### upload-scripts
58+
59+
Go script that connects to Azure storage, lists blobs within a specific container, and deletes them.
60+
- [Upload Scripts README](https://github.com/CDCgov/data-exchange-upload/blob/main/upload-scripts/README.md)
61+
5062
### upload-server
5163

5264
Upload server functionality leveraging Tus v2 capabilities written in Golang. Capabilities include resumable file uploads, metadata verification, event routing, observability endpoints, file delivery, distributed file locking, OAuth token verification, user interface, unit testing, and integration testing.
5365
- [Upload Server README](https://github.com/CDCgov/data-exchange-upload/blob/main/upload-server/readme.md)
5466

55-
5667
## TUS Protocol
5768

5869
This repository is using the TUS resumable upload protocol: [https://tus.io/](https://tus.io/), and reference implementation: [https://github.com/tus/tusd](https://github.com/tus/tusd)
5970

60-
6171
## Example Usage
6272

6373
Example clients, for back-end or browser (front-end), to upload files: [https://github.com/CDCgov/data-exchange-api-examples](https://github.com/CDCgov/data-exchange-api-examples)
6474

65-
6675
## Future Improvements
6776

6877
- Upload routing configuration defined within the upload server; removes JSON configuration file dependency
6978

70-
7179
## Public Domain Standard Notice
7280

7381
This repository constitutes a work of the United States Government and is not subject to domestic copyright protection under 17 USC § 105. This repository is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/). All contributions to this repository will be released under the CC0 dedication. By submitting a pull request you are agreeing to comply with this waiver of copyright interest.
7482

75-
7683
## License Standard Notice
7784

7885
The repository utilizes code licensed under the terms of the Apache Software License and therefore is licensed under ASL v2 or later. <br/>
@@ -85,24 +92,20 @@ You should have received a copy of the Apache Software License along with this p
8592

8693
The source code forked from other open source projects will inherit its license.
8794

88-
8995
## Privacy Standard Notice
9096

9197
This repository contains only non-sensitive, publicly available data and information. All material and community participation is covered by the [Disclaimer](https://github.com/CDCgov/template/blob/master/DISCLAIMER.md) and [Code of Conduct](https://github.com/CDCgov/template/blob/mastercode-of-conduct.md). For more information about CDC's privacy policy, please visit [http://www.cdc.gov/other/privacy.html](https://www.cdc.gov/other/privacy.html).
9298

93-
9499
## Contributing Standard Notice
95100

96101
Anyone is encouraged to contribute to the repository by [forking](https://help.github.com/articles/fork-a-repo) and submitting a pull request. (If you are new to GitHub, you might start with a [basic tutorial](https://help.github.com/articles/set-up-git).) By contributing to this project, you grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users under the terms of the [Apache Software License v2](http://www.apache.org/licenses/LICENSE-2.0.html) or later. <br/>
97102

98103
All comments, messages, pull requests, and other submissions received through CDC including this GitHub page may be subject to applicable federal law, including but not limited to the Federal Records Act, and may be archived. Learn more at [http://www.cdc.gov/other/privacy.html](http://www.cdc.gov/other/privacy.html).
99104

100-
101105
## Records Management Standard Notice
102106

103107
This repository is not a source of government records, but is a copy to increase collaboration and collaborative potential. All government records will be published through the [CDC web site](http://www.cdc.gov).
104108

105-
106109
## Additional Standard Notices
107110

108111
Please refer to [CDC's Template Repository](https://github.com/CDCgov/template)for more information about [contributing to this repository](https://github.com/CDCgov/template/blob/master/CONTRIBUTING.md), [public domain notices and disclaimers](https://github.com/CDCgov/template/blob/master/DISCLAIMER.md), and [code of conduct](https://github.com/CDCgov/template/blob/master/code-of-conduct.md).

0 commit comments

Comments
 (0)