README.md

Strigo's REST API Docs

The API Reference is available at https://docs.strigo.io.

Installing and running locally

1. Install the latest Hugo:

   • On CentOS:

     1. Install the copr plugin for yum: sudo yum install yum-plugin-copr
     2. Enable the Hugo repository: sudo yum copr enable daftaupe/hugo
     3. Install Hugo: sudo yum install hugo

   • On Ubuntu:

     • Install Hugo: sudo apt-get install hugo

   • On Windows:

     1. Install chocolatey.
     2. Install Hugo: choco install hugo -confirm

   • On MacOS:

     1. Install homebrew
     2. Install Hugo: brew install hugo

2. Verify that Hugo is installed: hugo version

3. Clone this repository

4. Change directory to the strigo-rest-docs directory

5. Install the theme submodule by running: git submodule init && git submodule update

6. Start the hugo web server: hugo server

7. Go to: http://localhost:1313

Publishing

We use Netlify to manage the docs' build process. Once a PR is merged to master, if everything went well, it will be available for publishing.

To publish a new version:

1. Go to https://github.com (preferably in incognito mode) and sign in as strigops
2. Go to https://app.netlify.com/sites/strigo-rest-docs/overview and sign in with GitHub
3. Click the relevant item under "Production deploys", which represents the commit you want to deploy.
4. Click the "Publish deploy" button.
5. Done! The docs should now be up-to-date.

Contribution

PRs are always welcome :)