From ffe0634dc73615550d535f2d62f26ff155096563 Mon Sep 17 00:00:00 2001 From: Natalia Luzuriaga Date: Wed, 27 Aug 2025 11:26:22 -0700 Subject: [PATCH 1/3] Added agency-index.md Signed-off-by: Natalia Luzuriaga --- docs/agency-index.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 docs/agency-index.md diff --git a/docs/agency-index.md b/docs/agency-index.md new file mode 100644 index 0000000..b2241c0 --- /dev/null +++ b/docs/agency-index.md @@ -0,0 +1,6 @@ +## agency-index.json + +The SHARE IT Act requires federal agencies to publish metadata for their software projects. This metadata is compiled into an **agency-index.json** file, which serves as a centralized inventory of the agency's software portfolio. + + +Agency index files are found here: https://github.com/DSACMS/code-gov/tree/main/agency-indexes \ No newline at end of file From 15bdd3d536006f0271e49314685a1389ce5f7c82 Mon Sep 17 00:00:00 2001 From: Natalia Luzuriaga Date: Wed, 27 Aug 2025 11:33:16 -0700 Subject: [PATCH 2/3] Add agency journey content in agency-index.md Signed-off-by: Natalia Luzuriaga --- docs/agency-index.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/agency-index.md b/docs/agency-index.md index b2241c0..293696d 100644 --- a/docs/agency-index.md +++ b/docs/agency-index.md @@ -2,5 +2,13 @@ The SHARE IT Act requires federal agencies to publish metadata for their software projects. This metadata is compiled into an **agency-index.json** file, which serves as a centralized inventory of the agency's software portfolio. +To create an agency-index.json: +1. Identify GitHub organizations and other platforms where source code is hosted +2. Generate the agency-index.json using the tools below. Learn more about usage in [procedures.md](https://github.com/DSACMS/gov-codejson/blob/main/docs/procedures.md#generate-an-agency-indexjson-file-for-agencies) + - [index-generator-website](https://dsacms.github.io/index-generator-website/) + - [index-generator python tool](https://github.com/DSACMS/codejson-index-generator) +3. Provide the index at: + - Agency's top level domain (TLD) + - A GitHub repository Agency index files are found here: https://github.com/DSACMS/code-gov/tree/main/agency-indexes \ No newline at end of file From abc68978e6d913837592059e88f4db62ce4200fa Mon Sep 17 00:00:00 2001 From: Natalia Luzuriaga Date: Wed, 27 Aug 2025 12:09:43 -0700 Subject: [PATCH 3/3] Updated README Signed-off-by: Natalia Luzuriaga --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 03dae57..666e642 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,11 @@ code.json: An agency-wide metadata standard for software projects This repository contains documentation on code.json, a metadata standard used to collect information on the agency's software projects in compliance with [M-16-21](https://obamawhitehouse.archives.gov/sites/default/files/omb/memoranda/2016/m_16_21.pdf) and the [SHARE IT Act](https://www.congress.gov/bill/118th-congress/house-bill/9566/text/ih). - [metadata.md](./docs/metadata.md): Overview on code.json metadata standard +- [agency-index.md](./docs/agency-index.md): Overview on agency-index.json file - [schemas](./schemas): code.json generic schema and agency-level schemas - [procedures.md](./docs/procedures.md): Procedures and tools on creating and updating metadata - [examples.md](./docs/examples.md): Good examples of metadata in current agency code.json files + - [faq.md](./docs/faq.md): Frequently Asked Questions ### Project Vision