This repository contains the documentation for Users.
Install and configure gitbook-cli
$ npm install
Serve the documentation locally
$ npm run init-gitbook $ npm run serve
Point your browser to http://localhost:4000/
Generating the static website
$ npm run build
Generating the documentation in other formats
$ 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.
Releasing a new version of the documentation
Assuming current stable is
16.4.0, you are about to release
16.5.0 and the next version is going to be
16.6.0, you would execute —
CURRENT_VERSION=16.4.0 VERSION_TO_RELEASE=16.5.0 NEXT_VERSION=16.6.0 REMOTE_NAME=upstream rake bump_version
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.