Open.gsa.gov is the current developer portal for all GSA data, APIs, and code open to the public. This repo is where we will be managing development of this portal.
This particular site is made for use with cloud.gov Pages in mind.
See the wiki for more info related to this site including a product roadmap, personas, and guides.
There are some security requirements governing your participation in editing the API documents hosted in this repository. Namely:
- All commits must have a signature
- All pull requests must be reviewed and approved by someone other than the individual who opened the pull request
Commit signing provides an additional layer of verification, ensuring that changes are made by those who are authorized to do so.
If you are making edits directly on the GitHub website, GitHub will automatically handle signing your commits. If you are pushing your change from your local system, then you will have to ensure that you are correctly signing your commits using your Git application. To get started with commit signing, GitHub's documentation on commit signature verification for instructions on how to configure your Git client and GitHub account. You may use any signing method (GPG, SSH, or S/MIME).
Reviews help provide additional confirmation that changes to the website are acceptable.
If you are opening a pull request to make a change, please arrange for another person on your team to review and approve your change. That reviewer will need to have the proper access to this repository. Please see the list of API Documentation Editors to make sure the reviewer already has access to this repository. If not, please contact us to have them added. Reviewers can refer to GitHub's documentation on approving a pull request for instructions.
This is a statically generated site built using Jekyll.
You will need to have Ruby version 3 following installed on your machine. See the .ruby-version file for the current version this project uses.
To install Bundler and then the dependencies:
gem install bundler
bundle install
The preferred method for running Jekyll is with bundle exec rake serve.
Note that this method will rebuild the entire site every time you make a change to any file. If you want faster builds, you can use bundle exec rake incrementalserve, which comes with some caveats, notably only changed files will be rebuilt. This means if you change a data file, HTML pages that use that data file won't be updated.
This project is in the worldwide public domain. As stated in CONTRIBUTING:
This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.
All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.