Workflow

IN PROGRESS: This section is in the early planning stages and is subject to change. Stay tuned for details.

Updated 01-17-19

Publishing California state government open source projects to code.ca.gov adopts the code.json data management protocol, the same employed by the U.S. Government’s code.gov and NASA’s code.nasa.gov.

code.json

As code.gov and code.nasa.gov do, code.ca.gov will leverage the JSON protocol to publish publicly-available state open source projects.

About JSON:

In computing, JavaScript Object Notation or JSON is an open-standard file format that uses human-readable text to transmit data objects consisting of attribute–value pairs and array data types (or any other serializable value). It is a very common data format used for asynchronous browser–server communication. (Wikipedia)

The code.json file allows agencies to create a simple file from an established template, input information related to all of the organization’s public open source projects (i.e., repositories), then post this file on its primary website for data harvesting into the code.ca.gov platform.

code.json Placement

Each code.json file needs to be placed in a public facing location where the raw json can be read. This can be accomplished by either placing the file on github and using a raw link (example) or the file can be placed in a publicly available location on an agencies website.

Updating the Metadata Location File

In order for Code.ca.gov to inventory agency code, a single source with reference to each code.json file is necessary.

We house this file on GitHub . To update this file with the location of a new code.json file, make a pull request with the new changes and we will review and merge the changes.

Resources

California will leverage existing tools and resources created through the federal government’s Code.gov team: