This is the working repository for TACC's version of the Agave Science-as-a-Service API. It uses the Slate static documentation generator.
- 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.
- Fork this repository on GitHub
- Clone your forked repository (not the original one) to your hard drive with
git clone https://github.com/YOURGITHUBUSERNAME/docs.agaveapi.tacc.cloud.git agave-docs
cd agave-docs
- Add a remote branch
git remote add upstream https://github.com/mwvaughn/docs.agaveapi.tacc.cloud.git
git checkout -b <new_branch>
docker-compose up -d
- View API docs at http://localhost:4567/
- Edit away inside
source/
- Commit your changes and merge into
develop
- Issue a PR against the upstream
mwvaughn/agaveapi.docs.tacc.cloud
repository
Stash or commit your existing work
cd agave-docs
git pull upstream develop
git merge develop
Learn more about editing Slate markdown. Learn how to publish your docs to GitHub.
docker-compose up -d
launches (or tries to) a doc server on port 4567docker-compose down
will shut down the serverdocker-compose restart
will, not surprisingly, restart the doc serverdocker-compose build
will, not surprisingly, restart the doc serverdocker-compose logs slateapp
will display logs, which can be helpful in debugging rendering issuesdocker run --rm -v $(pwd):/usr/src/docs -w /usr/src/docs ruby:2.3.1 bundle lock --update
updates local Gemfile.lock