Skip to content

ucladevx/api-docs

Repository files navigation

UCLA DevX API

Set Up

make setup

Development

make dev

This will allow you to see the docs at: http://localhost:4567

Now that Slate is all set up on your machine, you'll probably want to learn more about editing Slate markdown

Publishing Docs

After making your changes, add the ec2 remote repo. Please contact a DevX exec for this:

git remote add prod root@<amazon-instance-public-dns>:/path/to/repo

Then, run this to create a build folder with our html file:

make build

Then, add the build folder as well as any other files you changed and commit them:

git add build/* <any other files>
git commit

Finally, push to prod:

git push prod

Documentation Powered by Slate