Scalyr's Documentation Repository

Welcome to Scalyr's documentation source repository. The site was forked from Google's docsy theme and runs on the hugo static website tool.

We appreciate your contributions and issue submissions, as Scalyr changes quickly and we sometimes miss things. To contribute, just follow the setup instructions below to fork, clone and test locally. Once your changes are ready, just submit a pull request.

You can create issues directly from Scalyr's Online Documantation.

Install Hugo

You need a recent version of Hugo to build the documentation locally (preferably 0.45+). If you install from the release page, make sure to get the extended Hugo version which supports SCSS. Alternatively, on macOS you can install Hugo via Brew.

If you want to do stylesheet changes, you will also need PostCSS to create the final assets. You can also install it locally with npm install.

Setup

1. Fork the source

2. Clone it to your dev machine

3. Add the repository as an upstream remote:
   git remote add upstream git@github.com:scalyr/doc.git

`git remote set-url --push upstream no_push`

Run Locally

1. cd doc

2. npm install

3. hugo server

If all goes well, the documentation should be running at http://localhost:1313/. Hugo watches for changes, so edits should automatically appear.

Edit & Submit

1. Create a branch for your changes:
   git checkout -b my_branch_name

2. Edit the documentation (only changes in the /content folder will be accepted)

3. Keep your branch in sync:
   git fetch upstream
git rebase upstream/master

Request Review

1. Commit and push your edits:
   git commit -m "Add notes to explain changes"
git push -f ${your_remote_name} myfeature

2. Push the changes:
   git push -f ${your_remote_name} my_branch_name

3. Request the review from your fork of https://github.com/scalyr/doc

If any of this is new to you, the good folks over at Kubernetes have created a nice writeup on this type of Github workflow.

Thank you from the Scalyr team!