akshaykarle / documentation

User & Developer Documentation for Go OSS

Home Page:http://www.go.cd/documentation

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Documentation for Go OSS

This repository contains the documentation for Developers and Users.

Contributing

Install and configure gitbook-cli

$ npm install

Serve the documentation locally

$ cd [user|developer]
$ gitbook install
$ gitbook serve

Point your browser to http://localhost:4000/

Generating the static website

$ gitbook build [path_to_repository]

Generating the documentation in other formats

$ gitbook [pdf|epub|mobi] build [output]

Publishing changes

The contents of the _book directory needs to be pushed out to the gh-pages branch of the repository.

Contributing

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.

License

Copyright 2015 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.

About

User & Developer Documentation for Go OSS

http://www.go.cd/documentation

License:Apache License 2.0


Languages

Language:Shell 71.2%Language:JavaScript 20.4%Language:CSS 8.5%