https://github.com/gocd/docs.go.cd
GoCD user documentation
https://github.com/gocd/docs.go.cd
documentation gocd
Last synced: 11 months ago
JSON representation
GoCD user documentation
- Host: GitHub
- URL: https://github.com/gocd/docs.go.cd
- Owner: gocd
- License: apache-2.0
- Created: 2016-02-15T06:06:00.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2025-07-22T04:20:24.000Z (11 months ago)
- Last Synced: 2025-07-22T06:43:15.532Z (11 months ago)
- Topics: documentation, gocd
- Language: HTML
- Homepage: https://docs.gocd.org
- Size: 168 MB
- Stars: 42
- Watchers: 21
- Forks: 137
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Documentation for GoCD - Continuous Delivery server
This repository contains the source code for the user documentation for [GoCD](https://www.gocd.org/). The documentation is available at https://docs.gocd.org/current/.
## Contributing
We encourage you to contribute to GoCD. For information on contributing to GoCD, please see our [contributor's guide](https://www.gocd.org/contribute). A lot of useful information like links to user documentation, design documentation, mailing lists etc. can be found in the [resources](https://www.gocd.org/community/resources.html) section.
To make changes to GoCD's documentation, you can do this:
1. Install all dependencies
The dependencies for building the documentation are:
- nodejs (known to work with v18)
- Ruby (known to work with 3.2)
Then run this to get all the dependent gems:
```shell
bundle
```
2. To install npm dependencies
```bash
npm install
```
3. Run the documentation on the local server (defaults to http://localhost:1313)
```shell
npm run index
npm run serve
```
### Publishing to GitHub pages
The contents of the `public` directory needs to be pushed out to the *[gh-pages](https://github.com/gocd/docs.go.cd/tree/gh-pages)* branch of the repository.
```shell
bundle exec rake publish
```
Check the latest changes deployed [here](https://gocd.github.io/docs.go.cd/).
#### To build search index
```shell
npm run index
```
#### To run hugo with different arguments
```shell
npm run hugo [arguments]
```
## License
```plain
Copyright 2022 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.
```