From 94eaf4c8c4977e8186c291912bd8b43ea7d34eb8 Mon Sep 17 00:00:00 2001 From: Isaac Milarsky Date: Wed, 11 Jun 2025 11:41:49 -0500 Subject: [PATCH 1/6] add initial docs Signed-off-by: Isaac Milarsky --- README.md | 15 ++++++--------- docs/overview.md | 36 ++++++++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+), 9 deletions(-) create mode 100644 docs/overview.md diff --git a/README.md b/README.md index 617bcd02..d67a198c 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,12 @@ -# CMS Open Source Program Office Guide +# Code-gov -ospo-guide is a collection of resources written by the CMS Open Source Program Office. -https://dsacms.github.io/ospo-guide/ +Code-gov is a redux project aiming to replicate the functionality provided by code.gov. This site aims to provide a software inventory and informational resource about open source projects throughout the federal government. -What's in the guide: +This site is populated through GitHub actions and Python scripts that save data that is used by a static eleventy site that replicates the functionality of the old code.gov. -- [Inbound](https://dsacms.github.io/ospo-guide/inbound/) -- [Outbound](https://dsacms.github.io/ospo-guide/outbound) -- [Growing](https://dsacms.github.io/ospo-guide/growing) -- [Resources](https://dsacms.github.io/ospo-guide/resources) -- [About](https://dsacms.github.io/ospo-guide/about) +This strategy serves to create a responsive agile site that reduces costs while providing a valuable resource on government code repositories. + +This is accompished through the code.json metadata standard. # Digital Service at CMS (DSACMS) diff --git a/docs/overview.md b/docs/overview.md new file mode 100644 index 00000000..9c70b8a4 --- /dev/null +++ b/docs/overview.md @@ -0,0 +1,36 @@ + +## What is Code-gov? + +Code-gov is a github pages site that provides an inventory of federal government software projects. Similar to the previous iteration of code.gov developed and maintained at GSA. Unlike the previous version however this version is a static github pages site populated by GitHub action workflows that call Python scripts. + + +## What are the features of code-gov? + +1. Open Source metadata + + Code-gov hosts open source metadata for projects at many agencies throughout the federal government. This metadata has lots of different elements such as license information, labor hours worked, and the URL at which the project is primarily hosted. + +2. Federal Open Source Policy Compliance + + The site encourages developers that develop code for the Federal government to abide by Federal policy regarding source code. Key policy in this regard includes [OMB Memorandum M-16-21](https://www.opm.gov/about-us/open-government/digital-government-strategy/fitara/memorandum-for-open-source-software-policy/) as well as the [SHARE IT Act](https://www.congress.gov/bill/118th-congress/house-bill/9566). + +3. Searchable Catalog + + The site provides a Searchable catalog that allows users to see an inventory of Federal source code. This allows for users to find existing projects for their use cases such as contributing and finding similar existing work. + +4. Encouraging Public Contributions + + The site allows developers, businesses and citizens to view and assist with open issues and problems present on Federal open source projects. + +5. Supports Innovation + + Facilitates collaboration between government agencies and the tech community to improve public services. + + +## Who is code-gov for? + +- Government Agencies +- Developers and Researchers +- Businesses and Startups + +Code-gov is a comprehensive resource intended to promote open source standards and software reuse. Additionally, it is a great tool for government agencies as well as the developers that work with them. It provides a searchable catalog that can be used to see information about existing projects, thus promoting interoperability standards throughout the federal government and interdependent stakeholders. From b3f5977f699d595d35059e1617c43f39ae1d2cd4 Mon Sep 17 00:00:00 2001 From: Isaac Milarsky Date: Wed, 11 Jun 2025 11:44:14 -0500 Subject: [PATCH 2/6] add docs Signed-off-by: Isaac Milarsky --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index d67a198c..1e3c63fe 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ This strategy serves to create a responsive agile site that reduces costs while This is accompished through the code.json metadata standard. +See further documentation [here](./docs/overview.md) + # Digital Service at CMS (DSACMS) We're a group of civic-minded technologists transforming how the federal government delivers healthcare to the American people. The Digital Service at CMS (DSAC) consists of engineers, designers, and product managers—serving our country by building and maintaining the technology underpinning our national health care programs. From 78873d626a9d95b33e8810f749baf2c44c675675 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 11 Jun 2025 17:14:13 +0000 Subject: [PATCH 3/6] update contributors information --- COMMUNITY.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/COMMUNITY.md b/COMMUNITY.md index 17320233..b15f14fd 100644 --- a/COMMUNITY.md +++ b/COMMUNITY.md @@ -71,17 +71,17 @@ Total number of contributors: 8 8