Have questions, feedback, or issues with the APIs available at developer.nrel.gov? Contact us or let us know in the issue tracker.
This repository stores the website content and documentation for developer.nrel.gov. Contributions are welcome. To submit a change, fork this repo, commit your changes, and send us a pull request.
The content files to edit are in ./source
. To preview your changes you can use the Middleman preview server. To run Middleman:
developer.nrel.gov
repository on your computer (git clone https://github.com/NREL/developer.nrel.gov.git
).developer.nrel.gov
directory, run docker-compose up
.If you're working on Swagger documentation, you can run rake lint
locally to check for potential warnings or errors with the Swagger specification files.
staging
branch will automatically be deployed to the staging site.master
branch will automatically be deployed to the production site.Deploys may take a few minutes after pushing before they show up. You can check the status via the Actions tab above.