gocd / developer.go.cd

GoCD developer documentation

Documentation for GoCD - Continuous Delivery server

This repository contains the developer documentation for GoCD.

Build and run locally

Install honkit

$ npm install

Serve the documentation locally

$ npm run server

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

Generating the static website

$ npm run build

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 GoCD. 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 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.

developer.go.cd's Issues

Plugin writing guide is in source but not visible on website

At some point a lot of the docs were deleted and simplified. The plugin writing stuff is still here at https://github.com/gocd/developer.go.cd/tree/master/source/writing_go_plugins but is not accessible and indexed off the main page.

Need to figure out if this is still relevant/useful and how it relates to the stuff at https://plugin-api.gocd.org/current/plugin-structure/#dependencies

Vagrant box and file links not working

Hello,

The Vagrant box and file linked in the documentation are not available (404) https://github.com/gocd/developer.go.cd/blob/master/2/2.1.md, https://developer.go.cd/current/2/2.1.html. Is there an up to date version somewhere?

Thanks!

Node.JS is Dev Environment Prereq on Windows

I get the following error when building on Windows if the only JS host is the Windows Script Host.
** Execute requirejs:precompile:prepare_source rake aborted! ExecJS::ProgramError: TypeError: Object doesn't support this property or method D:/gocd/server/webapp/WEB-INF/rails.new/vendor/bundle/jruby/1.9/gems/execjs-2.6.0/lib/execjs/external_runtime.rb:39:inexec'
D:/gocd/server/webapp/WEB-INF/rails.new/vendor/bundle/jruby/1.9/gems/execjs-2.6.0/lib/execjs/external_runtime.rb:14:in initialize' D:/gocd/server/webapp/WEB-INF/rails.new/vendor/bundle/jruby/1.9/gems/execjs-2.6.0/lib/execjs/runtime.rb:44:incompile'
D:/gocd/server/webapp/WEB-INF/rails.new/vendor/bundle/jruby/1.9/gems/execjs-2.6.0/lib/execjs/module.rb:27:in compile'

Installing Node.JS eliminates the error. I recommend adding this as a prereq in section 2.1.1

Incorrect documentation link for notification plugin development

The current documentation for notification plugin development gives a 404

Go here https://developer.go.cd/current/writing_go_plugins/authentication/authentication_plugin_overview.html and click on the notification plugin section (Almost at the bottom)

I think you probably meant to be this link

https://developer.go.cd/current/writing_go_plugins/notification/notification_plugin_overview.html

Which is in line with all other 3 plugin types

Document the gradle task for new Spark APIs

Document newApi task for people to create new APIs in spark.

Update WebRequests Docs for disallowing Non Authentication Plugins

Web Requests are disallowed for Non-Authentication plugins from 16.8.0, update the docs to reflect the same.

Plugin JSON Schema

The documentation for writing go plugins has example JSON requests and responses, along with JSON Schema for validation.

Most of those JSON Schema are wrong and fail to validate the provided examples (Tested with http://www.jsonschemavalidator.net/)

Fixup rspec docs with improved instructions on running rspecs in the IDE.

Move developer docs to GitHub Wiki?

These docs haven't been updated in a while (and probably don't need to be updated frequently). Moreover, in most cases, developers would be interested in the latest version of the code, so maintaining older versions seems to be quite an overhead. (Anyone who needs help with older versions could ask in the chatroom).

We could just move the docs and setup instructions to the Github Wiki section of the main gocd repository.

@arvindsv @nyuday @ketan @GaneshSPatil @bdpiparva @maheshp @varshavaradarajan @jyotisingh Thoughts?

Update https://developer.gocd.org/current/7/7.2.html and https://developer.gocd.org/current/4/4.5.html

Please include a section on how to run integration tests on IntelliJ. Keeps failing.

Summary.md imcomplete markdown tag

  * [Common](4/4.4.md)
      * [Plugin Architecture](4/4.4.1.md)
      * [Agent - Server Communication](

at line 60

broken URL in navigation (handling web requests)

This link returns a 404 error
https://github.com/gocd/developer.go.cd/blob/737cf7d73a05dc0be77762e3b49a6ee44a78bc5a/source/writing_go_plugins/handling_web_requests.md