Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 1.59 KB

README.md

File metadata and controls

41 lines (29 loc) · 1.59 KB
Raw

AgaveAPI Docs (Powered by Slate)

This is the working repository for TACC's version of the Agave Science-as-a-Service API. It uses the Slate static documentation generator.

Getting started contributing to the Agave API docs

Prerequisites:

  • Linux or Mac OS X
    • We don't have enough experience with Docker for Windows to officially support it
  • Docker CE 17.07+
  • Git 2.12+
  • Proficiency with Markdown

You can develop using a local native Ruby workflow, but that's not supported by our project.

Quick Set Up

  1. Fork this repository on GitHub
  2. Clone your forked repository (not the original one) to your hard drive with git clone https://github.com/YOURUSERNAME/agaveapi.docs.tacc.cloud.git agave-docs
  3. cd agave-docs
  4. git checkout -b <new_branch>
  5. docker-compose -d up
  6. View API docs at http://localhost:4567/
  7. Edit away inside source/
  8. Commit your changes and merge into develop
  9. Issue a PR against the upstream TACC/agaveapi.docs.tacc.cloud repository

Learn more about editing Slate markdown. Learn how to publish your docs to GitHub.

Docker Compose Cheat Sheet

  • docker-compose -d up launches (or tries to) a doc server on port 4567
  • docker-compose down will shut down the server
  • docker-compose restart will, not surprisingly, restart the doc server
  • docker-compose logs slateapp will display logs, which can be helpful in debugging rendering issues

Need Help? Found a bug?