tibosuke/docs

📄 Documentation for Growthbeat

Setup | Building | Usage | What's included | Development

Setup

Required software

Go (>= v1.5): http://golang.org/
Hugo (>=v0.14) : http://gohugo.io/
Node.js (>=10.0) : https://nodejs.org/

Building

This documentaion site is powerd by Hugo hosted on Github Pages. To build a Hugo site you'll need to setup Golang and Hugo environment on your system. Please see Setup, If you are not familiar with Hugo, please check the Hugo quickstart guide.

Follow these steps to build Hugo site on your system:

$ git clone git@github.com:growthbeat/docs.git
$ cd docs
$ npm run bootstrap
$ npm start

Usage

Write a new article

Follow these steps to post a new article:

# Write an article
$ npm run post <File Name>.md
/path/to/docs/content/<File Name>.md created
# Writing
# commit
$ git add .
$ git commit -m "message"
$ git push

Update an article

After updating existing article in content, please change date. It is used as update date in this site.

Deployment

This blog uses wercker to deploy public to gh-pages branch automatically so you do not have to do it yourself. If you would like to know this configuration, please see wercker.yml. If you are not familiar with wercker, please check the wercker quickstart guide.

Development

Fork it ( https://github.com/[my-github-username]/docs/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create a new Pull Request

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, IT is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we'll adhere to those rules whenever possible.

License

Whenever code for docs is borrowed or inspired by awesome existing sources, we credit the original developer, designer or article in our code. Please create issue if you think any credit is absent.

tibosuke / docs