Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 14 additions & 0 deletions docs/agency-index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## 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.

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
Loading