Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edit README by adding table of contents and update overview, notices and disclaimers #498

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Edit README by adding table of contents and update overview, notices and disclaimers #498

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
be08fb3
update readme with table of contents and revised notices
Jan 6, 2025
c7a18d6
add section for CDC Managed Repo
Jan 6, 2025
eeaf5a1
resolve formatting issue
Jan 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
145 changes: 91 additions & 54 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,75 +1,112 @@
# CDCgov GitHub Organization Open Source Project Template
# Table of Contents
[1. Overview](#1-overview)
- [The Problem](#the-problem)
- [The Solution](#the-solution)

**Template for clearance: This project serves as a template to aid projects in starting up and moving through clearance procedures. To start, create a new repository and implement the required [open practices](open_practices.md), train on and agree to adhere to the organization's [rules of behavior](rules_of_behavior.md), and [send a request through the create repo form](https://forms.office.com/Pages/ResponsePage.aspx?id=aQjnnNtg_USr6NJ2cHf8j44WSiOI6uNOvdWse4I-C2NUNk43NzMwODJTRzA4NFpCUk1RRU83RTFNVi4u) using language from this template as a Guide.**
[2. Notices](#2-notices)
- [2.1 Privacy Standard Notice](#21-privacy-standard-notice)
- [2.2 Records Management Standard Notice](#22-records-management-standard-notice)
- [2.3 Domestic Copyright Protection Notice](#23-domestic-copyright-protection-notice)
- [2.4 Open Source Notice](#24-open-source-notice)
- [2.5 License Standard Notice](#25-license-standard-notice)
- [2.6 Github Notice](#26-github-notice)
- [2.7 Contributing Standard Notice](#27-contributing-standard-notice)

**General disclaimer** This repository was created for use by CDC programs to collaborate on public health related projects in support of the [CDC mission](https://www.cdc.gov/about/organization/mission.htm). GitHub is not hosted by the CDC, but is a third party website used by CDC and its partners to share information and collaborate on software. CDC use of GitHub does not imply an endorsement of any one particular service, product, or enterprise.
[3. General Disclaimer](#3-general-disclaimer)

## Access Request, Repo Creation Request
[4. CDC Managed Guidance](#4-cdc-managed-repository-guidance)
- [4.1 Access Request](#41-access-request)

* [CDC GitHub Open Project Request Form](https://forms.office.com/Pages/ResponsePage.aspx?id=aQjnnNtg_USr6NJ2cHf8j44WSiOI6uNOvdWse4I-C2NUNk43NzMwODJTRzA4NFpCUk1RRU83RTFNVi4u) _[Requires a CDC Office365 login, if you do not have a CDC Office365 please ask a friend who does to submit the request on your behalf. If you're looking for access to the CDCEnt private organization, please use the [GitHub Enterprise Cloud Access Request form](https://forms.office.com/Pages/ResponsePage.aspx?id=aQjnnNtg_USr6NJ2cHf8j44WSiOI6uNOvdWse4I-C2NUQjVJVDlKS1c0SlhQSUxLNVBaOEZCNUczVS4u).]_
# 1. Overview
The IDWA project aims to support state, local, territorial, and tribal public health departments by enhancing their ability to manage, search, and secure data.

## Related documents
## The Problem

* [Open Practices](open_practices.md)
* [Rules of Behavior](rules_of_behavior.md)
* [Thanks and Acknowledgements](thanks.md)
* [Disclaimer](DISCLAIMER.md)
* [Contribution Notice](CONTRIBUTING.md)
* [Code of Conduct](code-of-conduct.md)
Extracting data from PDFs is cumbersome and error-prone, particularly when dealing with multiple documents, resulting in low accuracy rates. This makes it difficult for public health departments to efficiently process and utilize critical data.

## Overview
## The Solution

Describe the purpose of your project. Add additional sections as necessary to help collaborators and potential collaborators understand and use your project.

## Public Domain Standard Notice
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.
This repository focuses on developing an application that helps public health departments create data-driven templates using Microsoft Azure to consistently extract data with a higher accuracy rate. The goal is to provide jurisdictions with a "starter kit" that enables them to easily build resources from the repository, provision their own Azure infrastructure, or replicate similar configurations in Amazon Web Services (AWS) or Google Cloud Platform (GCP).

## License Standard Notice
The repository utilizes code licensed under the terms of the Apache Software
License and therefore is licensed under ASL v2 or later.
+ [Return to Table of Contents](#table-of-contents).

This source code in this repository is free: you can redistribute it and/or modify it under
the terms of the Apache Software License version 2, or (at your option) any
later version.
# 2. Notices

This source code in this repository is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the Apache Software License for more details.
## 2.1 Privacy Standard Notice

You should have received a copy of the Apache Software License along with this
program. If not, see http://www.apache.org/licenses/LICENSE-2.0.html
This repository contains only non-sensitive, publicly available data and information. All material and community participation is covered by the [Disclaimer](DISCLAIMER.md) and [Code of Conduct](code-of-conduct.md).

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

## Privacy Standard Notice
This repository contains only non-sensitive, publicly available data and
information. All material and community participation is covered by the
[Disclaimer](DISCLAIMER.md)
and [Code of Conduct](code-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).

## Contributing Standard Notice
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.
+ [Return to Table of Contents](#table-of-contents).

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).
## 2.2 Records Management Standard Notice

## Records Management Standard Notice
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).

## Additional Standard Notices
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/main/CONTRIBUTING.md), [public domain notices and disclaimers](https://github.com/CDCgov/template/blob/main/DISCLAIMER.md), and [code of conduct](https://github.com/CDCgov/template/blob/main/code-of-conduct.md).
+ [Return to Table of Contents](#table-of-contents).


## 2.3 Domestic Copyright Protection Notice

This repository is a work of the United States Government and is not subject to domestic copyright protection under 17 U.S.C. § 105. If published in the public domain within the United States, copyright and related rights worldwide will be waived through the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/).

+ [Return to Table of Contents](#table-of-contents).

## 2.4 Open Source Notice

This repository is open source and follows [open practices](open_practices.md). Contributors are expected to adhere to the organization's [rules of behavior](rules_of_behavior.md).

+ [Return to Table of Contents](#table-of-contents).

## 2.5 License Standard Notice

The code in this repository is licensed under the Apache License 2.0 (ASL v2), or any later version at your discretion.

You are free to use, redistribute, and modify the source code under the terms of the Apache License 2.0. However, this software is distributed "as is", without any warranties of any kind, either express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, or non-infringement. In no event shall the authors or copyright holders be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the software or the use or other dealings in the software.

For full licensing details, refer to the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).

Additionally, any code forked from this open-source project will retain its original license.

+ [Return to Table of Contents](#table-of-contents).

## 2.6 Github Notice

GitHub is not hosted by the CDC, but is a third party website used by CDC and its partners to share information and collaborate on software. CDC use of GitHub does not imply an endorsement of any one particular service, product, or enterprise. If you are new to GitHub, we recommend starting with this
[basic tutorial](https://help.github.com/articles/set-up-git) to familiarize yourself with version control and collaboration.

+ [Return to Table of Contents](#table-of-contents).

## 2.7 Contributing Standard Notice

While we encourage continuous development of this repository's codebase, there is currently no designated department overseeing its management. If you'd like to contribute, you have two options:

1. Clone the repository and create a new repository in your organization's codebase with the changes you wish to implement.
- This option allows you to manage the changes independently within your own organization's environment.
2. Submit a pull request and contact the CDC to inquire whether a department has been assigned to manage the repository.
- If a CDC department is designated, you can coordinate with them for further changes.
- _Note_: 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).
- Also see [CONTRIBUTING.md](docs/CONTRIBUTING.md) and [CDC Managed Repository Guidance](#4-cdc-managed-repository-guidance).

+ [Return to Table of Contents](#table-of-contents).

# 3. General Disclaimer

This repository was created for use by CDC programs to collaborate on public health related projects in support of the [CDC mission](https://www.cdc.gov/about/organization/mission.htm).

+ [Return to Table of Contents](#table-of-contents).

# 4. CDC Managed Repository Guidance
## 4.1 Access Request

If the CDC manages the repository, contributors must submit an access request through the [CDC GitHub Open Project Request Form](https://forms.office.com/Pages/ResponsePage.aspx?id=aQjnnNtg_USr6NJ2cHf8j44WSiOI6uNOvdWse4I-C2NUNk43NzMwODJTRzA4NFpCUk1RRU83RTFNVi4u).

**Important**: Submitting a request requires a CDC Office365 login. If you do not have one, please contact your organization’s administrator to submit the request on your behalf.

For access to the CDCEnt private organization, please use the [GitHub Enterprise Cloud Access Request form](https://forms.office.com/Pages/ResponsePage.aspx?id=aQjnnNtg_USr6NJ2cHf8j44WSiOI6uNOvdWse4I-C2NUQjVJVDlKS1c0SlhQSUxLNVBaOEZCNUczVS4u).]

+ [Return to Table of Contents](#table-of-contents).
Loading