Merge pull request #40 from DSACMS/DSACMS/nat/agency-index-update

Docs: Updates to agency-index.json

Author: natalialuzuriaga

docs/agency-index.md

@@ -1,8 +1,8 @@
-## agency-index.json
+# 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.
 
-View the agency-index.json schema here: https://github.com/DSACMS/gov-codejson/tree/main/schemas/agency-index/schema-2.0.0.json
+## Generate an agency-index.json file for submission
 
 To create an agency-index.json:
 1. Identify GitHub organizations and other platforms where source code is hosted
@@ -13,4 +13,64 @@ To create an agency-index.json:
   - Agency's top level domain (TLD)
   - A GitHub repository
 
+## agency-index.json Fields
+
+<table>
+  <thead>
+    <tr>
+      <th>Field</th>
+      <th>Presence</th>
+      <th>Type</th>
+      <th>Description</th>
+      <th>Options/Examples</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>agency</td>
+      <td>required</td>
+      <td>str</td>
+      <td>The agency acronym for Clinger Cohen Act agency, as defined by the United States Government Manual.</td>
+      <td></td>
+    </tr>
+    <tr>
+      <td>measurementType/method</td>
+      <td>required</td>
+      <td>str</td>
+      <td>An enumerated list of methods for measuring the open source requirement.</td>
+      <td>
+        - linesOfCode<br>
+        - modules<br>
+        - cost<br>
+        - projects<br>
+        - systems<br>
+        - other<br>
+      </td>
+    </tr>
+    <tr>
+      <td>measurementType/ifOther</td>
+      <td>optional</td>
+      <td>str</td>
+      <td>A one- or two- sentence description of the measurement type used, if 'other' is selected as the value of 'method' field.</td>
+      <td></td>
+    </tr>
+    <tr>
+      <td>releases</td>
+      <td>required</td>
+      <td>array</td>
+      <td>An array of code.json objects containing each versioned source code release made available. </td>
+      <td></td>
+    </tr>
+    <tr>
+      <td>version</td>
+      <td>required</td>
+      <td>str</td>
+      <td>The version of the metadata schema in use. Implements semantic versioning 2.0.0 rules as defined at http://semver.org.</td>
+      <td></td>
+    </tr>
+  <tbody>
+<table>
+
+View the agency-index.json schema here: https://github.com/DSACMS/gov-codejson/tree/main/schemas/agency-index/schema-2.0.0.json
+
 More examples of agency index files can be found here: https://github.com/DSACMS/code-gov/tree/main/agency-indexes

schemas/agency-index/schema-2.0.0.json

@@ -1,7 +1,7 @@
 {
     "$schema": "https://json-schema.org/draft/2020-12/schema",
-    "title": "Code.gov Inventory",
-    "description": "A federal source code catalog",
+    "title": "Agency Source Code Inventory",
+    "description": "Agency source code catalog",
     "type": "object",
     "required": [
         "version",
@@ -39,16 +39,19 @@
         "releases": {
             "type": "array",
             "items": {
+                "type": "object",
+                "description": "A code.json object containing each versioned source code release made available.",
                 "allOf": [
                     {
                         "$ref": "../schema-2.0.0.json"
                     }
                 ]
             },
+            "description": "An array of code.json objects containing each versioned source code release made available.",
             "additionalProperties": false
         },
         "version": {
-            "description": "The version of the metadata schema in use. Implements semantic versioning 2.0.0 rules as defined at http://semver.org",
+            "description": "The version of the metadata schema in use. Implements semantic versioning 2.0.0 rules as defined at http://semver.org.",
             "type": "string"
         }
     }