Improved docs
This commit is contained in:
parent
2824ba5aaf
commit
5b890e4c8b
1 changed files with 37 additions and 6 deletions
43
README.md
43
README.md
|
|
@ -1,15 +1,46 @@
|
||||||
# Scope 2015 #
|
# Scopesessions website
|
||||||
|
|
||||||
scopesessions.org
|
scopesessions.org
|
||||||
|
|
||||||
* Built with Jekyll
|
* Built with Jekyll
|
||||||
* 0.0.1
|
* 1.0.0
|
||||||
* [Learn Markdown](https://bitbucket.org/tutorials/markdowndemo)
|
* [Learn Markdown](https://bitbucket.org/tutorials/markdowndemo)
|
||||||
|
|
||||||
### Development ###
|
**NOTE:** There are two branches:
|
||||||
|
* dev: development branch, merge to master when production-ready
|
||||||
|
* master: production code, always keep functional and error-free
|
||||||
|
|
||||||
1. Install [Jekyll](http://jekyllrb.com)
|
### Development
|
||||||
2. Serve files
|
|
||||||
|
* Install [Jekyll](http://jekyllrb.com)
|
||||||
|
* Clone repository
|
||||||
|
```
|
||||||
|
git clone https://acorbi@bitbucket.org/acorbi/scopesessions.org.git
|
||||||
|
```
|
||||||
|
* Install dependencies
|
||||||
|
```
|
||||||
|
bower install
|
||||||
|
```
|
||||||
|
* Serve files
|
||||||
```
|
```
|
||||||
#!
|
|
||||||
jekyll serve
|
jekyll serve
|
||||||
```
|
```
|
||||||
|
* If changes in dev or other branch want to be published, first they need to be merged with on master branch
|
||||||
|
```
|
||||||
|
git checkout master
|
||||||
|
git merge dev
|
||||||
|
git commit -m "MESSAGE"
|
||||||
|
git push
|
||||||
|
```
|
||||||
|
|
||||||
|
### Deployment
|
||||||
|
|
||||||
|
* Build files
|
||||||
|
```
|
||||||
|
jekyll build
|
||||||
|
```
|
||||||
|
* SSH into scopesessions.org and pull the changes from master
|
||||||
|
```
|
||||||
|
cd /var/www/vhosts/scopesessions.org
|
||||||
|
git pull
|
||||||
|
```
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue