bosun.org@v0.0.0-20210513094433-e25bc3e69a1f/docs/README.md (about)

     1  These are the official docs for bosun, and the source code for https://bosun.org. They are in the main bosun repo so that documentation can be included with code changes in the same pr.
     2  
     3  Once changes have been committed to master they will show up on the https://bosun.org website as soon as github pages picks them up.
     4  
     5  The best way to develop locally is to use docker. This can be run using the `docker-compose.yml` inside the `docker` 
     6  directory. This is because it includes some github pages specific libraries that are needed for everything to render 
     7  correctly.
     8  
     9  Alternatively you can use jekyll locally (however more gems are needed to render correctly):
    10  
    11  ```
    12  gem install jekyll
    13  gem install jekyll-redirect-from
    14  jekyll server
    15  ```