This repository contains the documentation for Users.
Install and configure gitbook-cli
$ npm install
$ gitbook install
$ gitbook serve
Point your browser to http://localhost:4000/
$ gitbook build [path_to_repository]
$ gitbook [pdf|epub|mobi] build [output]
The contents of the _book directory needs to be pushed out to the gh-pages branch of the repository.
We encourage you to contribute to Go. For information on contributing to this project, please see our contributor's guide. A lot of useful information like links to user documentation, design documentation, mailing lists etc. can be found in the resources section.
Bump the version in user-ci.sh on the master branch.
$ git checkout master
$ vim user-ci.sh # Bump version in `version` to new version e.g.`version=16.3.0`.
$ git add user-ci.sh
$ git commit -m 'Bump version'
$ git push upstream master
build.go.cd will create 16.3.0 folder under gh-pages branch and site will be updated.
Once the version is published link the current to new version.
$ git fetch --all
$ git checkout gh-pages
$ git merge upstream/gh-pages
$ ln -sf 16.3.0 current # current is now a symlink to 16.3.0
$ git add current
$ git commit -m 'Link new version to current'
$ git push
Copyright 2016 ThoughtWorks, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.