Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

update docs to new format. remove developer notes

  • Loading branch information...
commit 7749de12298e3ee8d52601e56414de9152015b36 1 parent 3d9fd62
@technoweenie technoweenie authored
Showing with 329 additions and 1,412 deletions.
  1. +0 −28 docs/CodePorting-C#2Java
  2. +0 −22 docs/active_collab
  3. +6 −0 docs/activecollab
  4. +3 −11 docs/{agile_bench → agilebench}
  5. +9 −26 docs/amqp
  6. +2 −12 docs/apoio
  7. +4 −9 docs/appharbor
  8. +18 −29 docs/bamboo
  9. +8 −17 docs/basecamp
  10. +0 −27 docs/basecamp_classic
  11. +10 −0 docs/bcx
  12. +4 −15 docs/boxcar
  13. +0 −9 docs/bugherd
  14. +8 −23 docs/bugly
  15. +0 −15 docs/bugzilla
  16. +1 −0  docs/buildcoin
  17. +1 −19 docs/campfire
  18. +0 −11 docs/codeclimate
  19. +11 −0 docs/codeportingcsharp2java
  20. +1 −15 docs/{co_op → coop}
  21. +3 −20 docs/cube
  22. +1 −0  docs/ducksboard
  23. +1 −15 docs/email
  24. +2 −14 docs/flowdock
  25. +8 −24 docs/{fog_bugz → fogbugz}
  26. +2 −17 docs/freckle
  27. +1 −15 docs/{friend_feed → friendfeed}
  28. +0 −12 docs/gemnasium
  29. +1 −10 docs/geocommit
  30. +0 −16 docs/{get_localization → getlocalization}
  31. +1 −13 docs/gitlive
  32. +1 −14 docs/grmble
  33. +0 −9 docs/{group_talent → grouptalent}
  34. +3 −11 docs/grove
  35. +0 −15 docs/harvest
  36. +3 −17 docs/hipchat
  37. +1 −12 docs/icescrum
  38. +1 −15 docs/jabber
  39. +6 −19 docs/jaconda
  40. +8 −0 docs/jenkins
  41. +0 −15 docs/jenkins_github
  42. +1 −0  docs/{jenkins_git → jenkinsgit}
  43. +7 −21 docs/jira
  44. +2 −15 docs/kanbanery
  45. +0 −14 docs/kickoff
  46. +1 −4 docs/leanto
  47. +7 −21 docs/lighthouse
  48. +1 −13 docs/loggly
  49. +1 −16 docs/{mantis_bt → mantisbt}
  50. +4 −16 docs/masterbranch
  51. +0 −32 docs/mqtt
  52. +18 −0 docs/mqttpub
  53. +0 −12 docs/{notifymyandroid → nma}
  54. +0 −11 docs/nodejitsu
  55. +5 −17 docs/notifo
  56. +3 −10 docs/ontime
  57. +0 −11 docs/pachube
  58. +0 −11 docs/packagist
  59. +0 −18 docs/pivotal_tracker
  60. +6 −0 docs/pivotaltracker
  61. +4 −11 docs/planbox
  62. +3 −18 docs/presently
  63. +1 −13 docs/prowl
  64. +1 −10 docs/pushover
  65. +0 −9 docs/railsbp
  66. 0  docs/{rails_brakeman → railsbrakeman}
  67. +17 −27 docs/rally
  68. +1 −14 docs/rdocinfo
  69. +0 −15 docs/read_the_docs
  70. +1 −0  docs/readthedocs
  71. +3 −27 docs/rubyforge
  72. +0 −13 docs/scrumdo
  73. +5 −17 docs/shiningpanda
  74. +4 −3 docs/slatebox
  75. +0 −11 docs/snowyevening
  76. +6 −24 docs/socialcast
  77. +1 −3 docs/sourcemint
  78. +1 −11 docs/{splendid_bacon → splendidbacon}
  79. +0 −10 docs/{sqs_queue → sqsqueue}
  80. +0 −11 docs/stackmob
  81. +1 −17 docs/statusnet
  82. +4 −18 docs/talker
  83. +2 −21 docs/{target_process → targetprocess}
  84. +0 −6 docs/{test_pilot → testpilot}
  85. +4 −20 docs/toggl
  86. +12 −13 docs/trac
  87. +3 −2 docs/trajectory
  88. +8 −25 docs/travis
  89. +0 −13 docs/trello
  90. +2 −17 docs/twilio
  91. +4 −25 docs/twitter
  92. +5 −18 docs/unfuddle
  93. +1 −5 docs/{web_translate_it → webtranslateit}
  94. +5 −15 docs/yammer
  95. +0 −77 docs/you_track
  96. +23 −0 docs/youtrack
  97. +0 −12 docs/zendesk
  98. +7 −32 docs/zohoprojects
  99. +15 −16 services/mqtt.rb
View
28 docs/CodePorting-C#2Java
@@ -1,28 +0,0 @@
-CodePorting-C#2Java
-======
-
-Allows you to setup a GitHub repository to port C# code to Java on git commit.
-
-Install Notes
--------------
-
-1. Enter name for your project (It will be used to organize target repository structure)
-2. Enter name for your source repository, the one which contains CSharp code.
-3. Enter name for your target repository, the one which will contain the Java ported code (the target repository must be git initialized first).
-4. Signup for a CodePorting account at https://apps.codeporting.com/signup and add your CodePorting username/password above.
-5. <a href="https://github.com/login/oauth/authorize?client_id=bdd1c68e81a61ac64e45&scope=user,repo,gist">Authorize CodePorting to use your GitHub account</a> and enter GitHub access token above on service settings page.
-
-Developer Notes
----------------
-
-data
- - project_name
- - repo_key
- - target_repo_key
- - codeporting_username
- - codeporting_password
- - github_access_token
- - active
-
-payload
- - refer to docs/github_payload
View
22 docs/active_collab
@@ -1,22 +0,0 @@
-ActiveCollab
-========
-
-Install Notes
--------------
-
-1. Currently, you must specify in the configuration milestone and or category if you want the commits to be associated with them.
- In the future, I plan for this to have some form of configuration via tags / branches, or something like that.
-2. URL, Project ID, and Token are required the others not so much.
-
-Developer Notes
----------------
-
-data
- - url (called URL in /activecollab/public/index.php?path_info=people/:company_id/users/:user_id/api)
- - token (called Key in /activecollab/public/index.php?path_info=people/:company_id/users/:user_id/api)
- - project_id (in URL for /activecollab/public/index.php?path_info=projects/:project_id)
- - milestone_id (*OPTIONAL* in URL for /activecollab/public/index.php?path_info=projects/:project_id/milestones/:milestone_id)
- - category_id (*OPTIONAL* in URL for /activecollab/public/index.php?path_info=projects/:project_id/discussions&category_id=:category_id)
-
-payload
- - refer to docs/github_payload
View
6 docs/activecollab
@@ -0,0 +1,6 @@
+Install Notes
+-------------
+
+1. Currently, you must specify in the configuration milestone and or category if you want the commits to be associated with them.
+ In the future, I plan for this to have some form of configuration via tags / branches, or something like that.
+2. URL, Project ID, and Token are required the others not so much.
View
14 docs/agile_bench → docs/agilebench
@@ -5,17 +5,9 @@ Agile Bench
Install Notes
-------------
- 1. **token** - is a user's API token. Get it from your Agile Bench's user settings page.
- 2. **project_id** - can be found in your Agile Bench project URL. i.e. if the URL is http://agilebench.com/projects/3000-my-project, then the project id will be 3000.
+1. **token** - is a user's API token. Get it from your Agile Bench's user settings page.
-Git Commit example: `$ git commit -am "[Fixes #5 #6] Added even more documentation"` - will add _"Added even more documentation"_ to stories #5 and #6 and move stories #5 & #6 into the last (the fixed!) workflow state.
-
-Developer Notes
----------------
-data
- - token
- - project_id
+2. **project_id** - can be found in your Agile Bench project URL. i.e. if the URL is http://agilebench.com/projects/3000-my-project, then the project id will be 3000.
-payload
- - refer to docs/github_payload
+Git Commit example: `$ git commit -am "[Fixes #5 #6] Added even more documentation"` - will add _"Added even more documentation"_ to stories #5 and #6 and move stories #5 & #6 into the last (the fixed!) workflow state.
View
35 docs/amqp
@@ -1,48 +1,31 @@
-AMQP
-========
-
-This service lets you publish push and commit messages to a message broker
-(like RabbitMQ) via the AMQP protocol.
-
-
Install Notes
-------------
- 1. Host is the hostname of the AMQP broker
+ 1. Server is the hostname of the broker
2. Port is the port to connect (AMQP default is 5672)
3. Vhost is the vhost to use while publishing (default is '/')
4. Exchange is the exchange to use while publishing
* Note that the exchange is a durable topic exchange
- ** Future versions may allow you to configure this
+ * Future versions may allow you to configure this
5. Username is the user to use when publishing to the exchange
6. Password is the pasword to use when publishing to the exchange
* Note that SSL isn't supported yet
Messages are sent for a push with the following routing key format:
+
"github.push.#{owner}.#{repo}.#{ref}"
- where:
+ where:
+
owner = payload['repository']['owner']['name']
repo = payload['repository']['name']
ref = payload['ref_name']
Messages are also sent for each commit in a push, with the following routing
key format:
- "github.commit.#{owner}.#{repo}.#{ref}.#{author}"
- where:
- author = commit['author']['email']
- (other fields are the same as above)
-
-Developer Notes
----------------
+ "github.commit.#{owner}.#{repo}.#{ref}.#{author}"
-data
- - host
- - port
- - vhost
- - exchange
- - username
- - password
+ where:
-payload
- - refer to docs/github_payload
+ author = commit['author']['email']
+ (other fields are the same as above)
View
14 docs/apoio
@@ -4,16 +4,6 @@ Apoio
Install Notes
-------------
- 1. Subdomain is your Apoio subdomain ('http://subdomain.apo.io')
+1. Subdomain is your Apoio subdomain ('http://subdomain.apo.io')
+2. Token is your Apoio API token.
- 2. Token is your Apoio API token.
-
-Developer Notes
----------------
-
-data
- - subdomain
- - token
-
-payload
- - refer to docs/github_payload
View
13 docs/appharbor
@@ -1,15 +1,10 @@
-AppHarbor
-=======
-
AppHarbor is a .NET Platform as a Service. Use this service to automatically trigger build, test run and deployment of your AppHarbor application when you push to GitHub.
Install Notes
-------------
- 1. Go to your application's main page on AppHarbor and find the "Create build URL". Example: https://appharbor.com/application/{application_slug}/build?authorization={token}
-
- 2. "Token" is the value of the "authorization" parameter.
-
- 3. "Application Slugs" is a list of unique application identifiers delimited by "," (i.e. "foo" or "foo,bar") that pushes should trigger builds on.
+1. Go to your application's main page on AppHarbor and find the "Create build URL". Example: https://appharbor.com/application/{application_slug}/build?authorization={token}
+2. "token" is the value of the "authorization" parameter.
+3. "application_slug" is a list of unique application identifiers delimited by "," (i.e. "foo" or "foo,bar") that pushes should trigger builds on.
+4. If your GitHub repository is private you need to add the "apphb" GitHub user as a collaborator. This enables AppHarbor to download the source code.
- 4. If your GitHub repository is private you need to add the "apphb" GitHub user as a collaborator. This enables AppHarbor to download the source code.
View
47 docs/bamboo
@@ -7,32 +7,21 @@ The github Bamboo service can be used to trigger builds after code has been push
Install Notes
-------------
- 1. Your Bamboo server must be accessible from the internet.
-
- 2. "base_url" is the URL to your Bamboo server
- Example: https://bamboo.example.com/ or http://bamboo.example.com/bamboo/
-
- 3. "build_key" is the identifier of the plan you want to trigger
- Example: "BAM-TRUNK", where BAM = project key, TRUNK = plan key
-
- A compound build key value can be used to specify multiple builds or associate
- specific branches with a build
- Example: "master:BAM-TRUNK,3-2-patches:BAM-32PATCH,BAM-TESTS", where BAM-TRUNK
- will be triggered only by pushes to the master branch, BAM-32PATCH will only
- be triggered by pushes to the 3-2-patches branch, and BAM-TESTS will be triggered
- for any push.
-
- 4. "username" and "password" - username and password of a Bamboo user that can
- trigger a manual build of the Bamboo plan defined in "build_key"
-
-Developer Notes
----------------
-
-data
- - base_url
- - build_key
- - username
- - password
-
-payload
- - refer to docs/github_payload
+1. Your Bamboo server must be accessible from the internet.
+
+2. "base_url" is the URL to your Bamboo server
+ Example: https://bamboo.example.com/ or http://bamboo.example.com/bamboo/
+
+3. "build_key" is the identifier of the plan you want to trigger
+ Example: "BAM-TRUNK", where BAM = project key, TRUNK = plan key
+
+ A compound build key value can be used to specify multiple builds or associate
+ specific branches with a build
+ Example: "master:BAM-TRUNK,3-2-patches:BAM-32PATCH,BAM-TESTS", where BAM-TRUNK
+ will be triggered only by pushes to the master branch, BAM-32PATCH will only
+ be triggered by pushes to the 3-2-patches branch, and BAM-TESTS will be triggered
+ for any push.
+
+4. "username" and "password" - username and password of a Bamboo user that can
+ trigger a manual build of the Bamboo plan defined in "build_key"
+
View
25 docs/basecamp
@@ -1,21 +1,12 @@
-Basecamp
-========
+Basecamp Classic
+================
Install Notes
-------------
- 1. project_url is the URL of your Basecamp project: https://basecamp.com/1234/projects/5678
- 2. email_address is the email you sign in to Basecamp with. This person must have access to the project. To add events on behalf of other people, make the person an admin on the project.
- 3. password is the password you sign in to Basecamp with.
-
-
-Developer Notes
----------------
-
-data
- - project_url
- - email_address
- - password
-
-payload
- - refer to docs/github_payload
+ 1. **Url** should be your Basecamp url
+ 2. **Username** should be the username or API token of the user that you want to use to post messages into your Basecamp - you can setup a user just for this purpose
+ 3. **Password** should be the password of the user that you want to use to post the messages. If username is an API token, set password to 'x'.
+ 4. **Project** should be the name of the project that you want to post the message into (not the id)
+ 5. **Category** should be the name of the category that you want to post the message using (not the id)
+ 6. **SSL** should be enabled for accounts that need SSL.
View
27 docs/basecamp_classic
@@ -1,27 +0,0 @@
-Basecamp Classic
-================
-
-Install Notes
--------------
-
- 1. url should be your Basecamp Classic url
- 2. username should be the username or API token of the user that you want to use to post messages into your Basecamp - you can setup a user just for this purpose
- 3. password should be the password of the user that you want to use to post the messages. If username is an API token, set password to 'x'.
- 4. project should be the name of the project that you want to post the message into (not the id)
- 5. category should be the name of the category that you want to post the message using (not the id)
- 6. ssl should be enabled for accounts that need SSL.
-
-
-Developer Notes
----------------
-
-data
- - url
- - username
- - password
- - project
- - category
- - ssl
-
-payload
- - refer to docs/github_payload
View
10 docs/bcx
@@ -0,0 +1,10 @@
+Basecamp
+========
+
+Install Notes
+-------------
+
+ 1. project_url is the URL of your Basecamp project: https://basecamp.com/1234/projects/5678
+ 2. email_address is the email you sign in to Basecamp with. This person must have access to the project. To add events on behalf of other people, make the person an admin on the project.
+ 3. password is the password you sign in to Basecamp with.
+
View
19 docs/boxcar
@@ -1,21 +1,10 @@
-Boxcar
-==========
-
-Send your commits to Boxcar, a messaging platform. Get instant commit messages on your desktop and mobile devices.
-
Install Notes
-------------
- 1. Download and install Boxcar from http://boxcar.io
- 2. Type in the Boxcar e-mail addresses of the users wanting to be notified of commits to this repository.
- 3. If the user does not yet have Boxcar, we'll send them an e-mail to let them know where they can get it.
-
+Send your commits to Boxcar, a messaging platform. Get instant commit messages on your desktop and mobile devices.
-Developer Notes
----------------
+1. Download and install Boxcar from <http://boxcar.io>
-data
- - subscribers (csv list of e-mail addresses)
+2. Type in the Boxcar e-mail addresses of the users wanting to be notified of commits to this repository (comma separated).
-payload
- - refer to docs/github_payload
+3. If the user does not yet have Boxcar, we'll send them an e-mail to let them know where they can get it.
View
9 docs/bugherd
@@ -1,12 +1,3 @@
-BugHerd
-=======
-
BugHerd is the world's simplest bug tracker for the web. See: http://www.bugherd.com
BugHerd allows you to visually track issues on your website. Using the GitHub integration you can update tasks directly from GitHub commit messages.
-
-
-Install Notes
--------------
-
- 1. project key -- you will find this key in BugHerd as you setup a GitHub integration in your project. For more info, see https://bugherd.tenderapp.com/kb/third-party-integrations/github
View
31 docs/bugly
@@ -2,36 +2,21 @@ Bugly
=====
Bugly is a hosted bug and issue tracker. Integrating it with GitHub
-allows you to associate commits with issues and see commits in all
+allows you to associate commits with issues and see commits in all
timelines.
Install Notes
-------------
- 1. 'token' (REQUIRED) is an API token with read/write access to the
- account/project. Click the '+' sign in the lower left corner of
- your Bugly account, then click New token to create a new token
- for your user. Or click Quick Access, then the user you wish to
- create a token for, then click the API tokens tab, then click
- New API token.
+ 1. 'token' (REQUIRED) is an API token with read/write access to the
+ account/project. Go to Control Panel, Users, click on a user,
+ click the API Tokens tab, then click New token to create a new token.
- 2. 'account_name' (REQUIRED) is your Bugly account name. It would be
+ 2. 'account_name' (REQUIRED) is your Bugly account name. It would be
'foobar' in the following URL: http://foobar.bug.ly/
- 3. 'project_id' (OPTIONAL) is the ID of the Bugly project to associate
+ 3. 'project_id' (OPTIONAL) is the ID of the Bugly project to associate
all commits with. If no project_id is provided, commits will only
- appear in the account-wide timeline, not project timelines. The ID
- would be '321' in this URL: http://foo.bug.ly/projects/321-MyProject
-
-
-Developer Notes
----------------
-
-data
- - token
- - account_name
- - project_id
-
-payload
- - refer to docs/github_payload
+ appear in the account-wide timeline, not project timelines. The ID
+ would be '321' in this URL: http://foo.bug.ly/projects/321-MyProject
View
15 docs/bugzilla
@@ -1,6 +1,3 @@
-Bugzilla
-========
-
This service hook posts comments on Bugzilla bugs when commit messages
reference a bug by id number.
@@ -31,15 +28,3 @@ is included in the bug comment.
This hook requires Bugzilla version >= 3.4 to function correctly
and >= 4.0 to be able to close bugs.
-
-Settings
---------
-
- - server_url - The URL for the Bugzilla installation,
- eg `https://bugzilla.mozilla.org/`
- - username - Email address for Bugzilla user account
- - password - Password for the user account
- - integration_branch - If entered, only commits to this branch will result
- in bugs being closed
- - central_repository - Set to true to enable closing bugs and commenting on
- commits that were already pushed to another user's repository
View
1  docs/buildcoin
@@ -3,3 +3,4 @@ Buildcoin is a CI game that rewards users for committing often, keeping the buil
1. Sign up at http://buildcoin.com
2. On the Manage Company page you can find your Company API Key. Just paste it in here.
3. Enjoy.
+
View
20 docs/campfire
@@ -1,11 +1,8 @@
-Campfire
-========
-
Install Notes
-------------
1. subdomain is your campfire subdomain
- (ie 'your-subdomain' if you visit 'https://your-subdomain.campfirenow.com')
+ (ie 'your-subdomain' if you visit 'https://your-subdomain.campfirenow.com')
2. room is the actual room name, not the id
@@ -19,18 +16,3 @@ Install Notes
6. sound is the sound that should be played if play_sound is
true. defaults to 'rimshot'
-
-
-Developer Notes
----------------
-
-data
- - subdomain
- - token
- - room
- - sound
- - master_only
- - play_sound
-
-payload
- - refer to docs/github_payload
View
11 docs/codeclimate
@@ -1,6 +1,3 @@
-Code Climate
-============
-
Install Notes
-------------
@@ -9,11 +6,3 @@ Install Notes
To get your Token: Log into your Code Climate account, click the gear icon at the top-right, then click the Integration tab.
-Developer Notes
----------------
-
-data
- - token
-
-payload
- - refer to docs/github_payload
View
11 docs/codeportingcsharp2java
@@ -0,0 +1,11 @@
+CodePorting-C#2Java
+======
+
+Allows you to setup a GitHub repository to port C# code to Java on git commit.
+
+Install Notes
+-------------
+
+1. Signup for a CodePorting account at https://apps.codeporting.com/signup
+2. You can find your "User name" and "Password" on www.codeporting.com
+
View
16 docs/co_op → docs/coop
@@ -1,6 +1,3 @@
-Co-op
-========
-
Install Notes
-------------
@@ -8,15 +5,4 @@ Install Notes
2. token is your API token. You can find this token in the group management panel as the group administrator, eg: "http://coopapp.com/groups/1066/edit"
- 3. Commit messages show up as being from Cobot, the Co-op message robot
-
-
-Developer Notes
----------------
-
-data
- - group_id
- - token
-
-payload
- - refer to docs/github_payload
+ 3. Commit messages show up as being from Cobot, the Co-op message robot
View
23 docs/cube
@@ -1,23 +1,6 @@
-Cube
-==========
-
-Cube is a timetracking app for individuals or companies; for more details see http://cube.bitrzr.com
-This service lets your broadcast commits on Cube so they can be seen in the unified project log.
-
Install Notes
-------------
- 1. domain (company domain for Google Apps account or user email address for individual accounts)
- 2. project (project name)
- 3. token (project integration token as seen in the project's Settings tab)
-
-Developer Notes
----------------
-
-data
- - domain
- - project
- - token
-
-payload
- - refer to docs/github_payload
+ 1. **Domain** should be the company domain for Google Apps account or user email address for individual accounts.
+ 2. **Project** should be your project name.
+ 3. **Token** should be the project integration token as seen in the project's Settings tab.
View
1  docs/ducksboard
@@ -11,3 +11,4 @@ Install Notes
See https://ducksboard.jira.com/wiki/display/webhooks/GitHub for detailed instructions.
The required "Webhook Key" can be found in the Ducksboard widget settings, under the "Advanced Settings" tab. Up to 5 different keys, separated by SPACES, can be provided if many widgets must be updated from this repository.
+
View
16 docs/email
@@ -1,21 +1,7 @@
-Email
-========
-
Install Notes
-------------
-1. `address(es)` whitespace separated email addresses (at most two)
+1. `address` whitespace separated email addresses (at most two)
2. `secret` fills out the Approved header to automatically approve the message
in a read-only or moderated mailing list.
3. `send_from_author` uses the commit author email address in the From address of the email.
-
-Developer Notes
----------------
-
-data
- - address(es)
- - secret
- - send_from_author
-
-payload
- - refer to docs/github_payload
View
16 docs/flowdock
@@ -1,20 +1,8 @@
-Flowdock
-==========
-
-Broadcast this project's commits, pull requests, and issues and their
+Broadcast this project's commits, pull requests, issues, and their
respective comments to Flowdock.
+
Install Notes
-------------
API Token is a flow-specific token. You can find it either in the flow, or in Flowdock's Integrations help page at https://www.flowdock.com/help/integrations.
-
-
-Developer Notes
----------------
-
-data
- - token
-
-payload
- - refer to docs/github_payload
View
32 docs/fog_bugz → docs/fogbugz
@@ -1,13 +1,10 @@
-FogBugz
-=======
-
Install Notes
-------------
1. Requires FogBugz version 6.1 or above, and your FogBugz installation
must be accessible from the internet
- 2. "cvssubmit_url" is the url to the cvsSubmit.[php|asp] file on your
+ 2. "cvssubmit_url" is the url to the `cvsSubmit.[php|asp]` file on your
FogBugz server.
Example: https://server.com/fogbugz/cvsSubmit.php
@@ -20,25 +17,22 @@ Install Notes
FogBugz 7.0 and later Configuration
---------------
-Starting in FogBugz 7, there is a configuration page where you can setup
-multiple repositories. Each repository is given and ID that will be used
-by the cvsSubmit.asp page.
-
-In FogBugz:
+FogBugz 7 has a configuration page for multiple repositories. Each repository
+is given and ID that will be used by the cvsSubmit.asp page.
1. From the admin menu, select Source Control.
2. Click 'Create New Repository'.
- 3. An option pane will pop up. Select 'Other (custom)'. Enter a name for
- the repository. The name does not have to be the same as the github repo
+ 3. An option pane will pop up. Select 'Other (custom)'. Enter a name for
+ the repository. The name does not have to be the same as the github repo
name. Click Next.
4. Set the 'Diff URL' field to be:
- https://github.com/[github_username]/[github_reponame]/commit/^R2
+ `https://github.com/[github_username]/[github_reponame]/commit/^R2`
5. Set the 'Log URL' field to be:
- https://github.com/[github_username]/[github_reponame]/commits/^FILE
+ `https://github.com/[github_username]/[github_reponame]/commits/^FILE`
6. There's a URL printed at the top of the configuration screen. Make
note of the number following ixRepository= That is the ID that needs
@@ -69,8 +63,6 @@ In your site configuration:
If you have commits in FogBugz from a previous source control system, or if
you want to use multiple GitHub accounts, please read:
-http://www.fogcreek.com/FogBugz/KB/howto/MultipleRepositories-Mult.html
-
In the service hook here:
1. Set your Cvssubmit Url.
@@ -79,13 +71,5 @@ In the service hook here:
3. Leave "Fb Repoid" blank.
-Developer Notes
----------------
-
-data
- - cvssubmit_url
- - fb_version (Valid options are 6 or anything else for 7, 8 or later)
- - fb_repoid
+<http://www.fogcreek.com/FogBugz/KB/howto/MultipleRepositories-Mult.html>
-payload
- - refer to docs/github_payload
View
19 docs/freckle
@@ -1,11 +1,7 @@
-freckle
-========
-
Install Notes
-------------
-Using the following URL as an example:
-https://nutsnbolts.letsfreckle.com
+Using the following URL as an example: https://nutsnbolts.letsfreckle.com
1. Account name: subdomain of the freckle account (nutsnbolts)
2. Token: the API token for an individual freckle user who is associated with the target freckle account (see instructions below)
@@ -13,15 +9,4 @@ https://nutsnbolts.letsfreckle.com
To get your API token: log into your freckle account, click Settings at the top right, then click the Integration (API) tab.
-Note about email addresses: the email address on a committer's GitHub account should match his/her email address on his/her freckle account. Otherwise, we can't identify the person who is logging time.
-
-Developer Notes
----------------
-
-data
- - subdomain
- - token
- - project name
-
-payload
- - refer to docs/github_payload
+Note about email addresses: the email address on a committer's GitHub account should match his/her email address on his/her freckle account. Otherwise, we can't identify the person who is logging time.
View
16 docs/friend_feed → docs/friendfeed
@@ -1,18 +1,4 @@
-FriendFeed
-==========
-
This service lets your broadcast your commits on FriendFeed. A simple post is made to http://www.friendfeed.com/api/share with your commits.
Example: 'Arun Thampi just pushed 56436bcdef2342ddfca234234 to github-services on GitHub'
-with the comment set as 'Integrated FriendFeed in github-services'
-
-
-Developer Notes
----------------
-
-data
- - nickname
- - remotekey [As specified by http://www.friendfeed.com/remotekey]
-
-payload
- - refer to docs/github_payload
+with the comment set as 'Integrated FriendFeed in github-services'
View
12 docs/gemnasium
@@ -1,9 +1,3 @@
-Gemnasium
-=========
-
-Install Notes
--------------
-
Gemnasium notifies you when new versions are released for your GitHub repositories' gem dependencies.
----
@@ -14,9 +8,3 @@ Gemnasium notifies you when new versions are released for your GitHub repositori
4. Check "Active"
5. Click "Update Settings"
-Developer Notes
----------------
-
- data
- - name
- - token
View
11 docs/geocommit
@@ -6,13 +6,4 @@ With this service you can send your commits to geocommit. Geocommit analyzes geo
Install Notes
-------------
- 1. Profit!
-
-Developer Notes
----------------
-
-data
- - none
-
-payload
- - refer to docs/github_payload
+ 1. Profit!
View
16 docs/get_localization → docs/getlocalization
@@ -1,9 +1,3 @@
-Get Localization
-===============
-
-Install Notes
--------------
-
1. Project name is your project name in Get Localization URL e.g:
Given this URL:
@@ -13,13 +7,3 @@ Install Notes
Your project name is "Example"
2. Project token is available at your project settings if you've GitHub support enabled.
-
-Developer Notes
----------------
-
-data
- - project_name
- - project_token
-
-payload
- - refer to docs/github_payload
View
14 docs/gitlive
@@ -1,7 +1,4 @@
-gitlive
-=======
-
-gitlive displays your GitHub pushes in realtime on your project homepage. See http://gitlive.com/ for more information.
+gitlive displays your GitHub pushes in realtime on your project homepage. See http://gitlive.com/ for mort information.
Install Notes
-------------
@@ -11,12 +8,3 @@ Install Notes
2. Generate widget at http://gitlive.com/ for embedding on your project page.
Note: Service is active after first push on GitHub.
-
-Developer Notes
----------------
-
-data
- - none
-
-payload
- - refer to docs/github_payload
View
15 docs/grmble
@@ -1,19 +1,6 @@
-Grmble
-========
-
Install Notes
-------------
1. room_api_url should be your room's API url from your room's admin page
Eg: http://grmble.com/api/room/ROOMKEY
- 2. token should be the API key from your room's admin page
-
-Developer Notes
----------------
-
-data
- - room_api_url
- - token
-
-payload
- - refer to docs/github_payload
+ 2. token should be the API key from your room's admin page
View
9 docs/group_talent → docs/grouptalent
@@ -9,12 +9,3 @@ Install Notes
1. Token - GitHub Service Hook Token for your GroupTalent project. Get it from the project configuration page.
-
-Developer Notes
----------------
-
-data
- - token
-
-payload
- - refer to docs/github_payload
View
14 docs/grove
@@ -1,18 +1,10 @@
Grove.io
=========
-Post deploy messages to Grove.io's IRC channels.
+This delivers updates to your GitHub repository to Grove.io's IRC channels.
+Events include Git pushes, issues, wiki changes, and comments.
Install Notes
-------------
- 1. `channel_token` - Channel's unique token which can be found from channel settings (available for organization owners)
-
-Developer Notes
----------------
-
-data
- - channel_token
-
-payload
- - refer to docs/github_payload
+ `channel_token` - Channel's unique token which can be found from channel settings (available for organization owners)
View
15 docs/harvest
@@ -1,19 +1,4 @@
-Harvest
-========
-
Install Notes
-------------
1. Applies the status to the currently clocked in project. Future updates are expected to include more versatility.
-
-Developer Notes
----------------
-
-data
- - username (your email address)
- - password (harvest password)
- - subdomain (subdomain for your business ex. {subdomain}.harvestapp.com)
- - ssl (boolean)
-
-payload
- - refer to docs/github_payload
View
20 docs/hipchat
@@ -1,6 +1,3 @@
-HipChat
-=======
-
Note: This service currently enables all of the available hook events including
commit comments, downloads, forks, fork applies, wiki updates, issues, issue
comments, member adds, pull requests, pushes, and watches. A full list with
@@ -9,17 +6,6 @@ descriptions can be found here: http://developer.github.com/v3/repos/hooks/
Install Notes
-------------
- 1. Auth token - One of your group's API tokens. See: http://www.hipchat.com/docs/api/auth
- 2. Room - The full name of the room to send the message to. The room's room_id will also work.
- 3. Notify - Whether or not to notify room members.
-
-Developer Notes
----------------
-
-data
- - auth_token
- - room
- - notify (boolean)
-
-payload
- - refer to docs/github_payload
+1. **Auth Token** - One of your group's API tokens. See: http://www.hipchat.com/docs/api/auth
+2. **Room** - The full name of the room to send the message to. The room's room_id will also work.
+3. **Notify** - Whether or not to notify room members.
View
13 docs/icescrum
@@ -19,15 +19,4 @@ Install Notes
2. **username** - Username of one team member in the project (such as the ScrumMaster).
3. **password** - Password of one team member in the project.
4. **base_url** - Base_url is the url where your iceScrum is alive (http://www.example.com/icescrum). This is input is optional if not set "https://www.kagilum.com/a" for iceScrum Cloud customers.
-
-Developer Notes
----------------
-
-data
- - username
- - password
- - project_key
- - base_url
-
-payload
- - refer to docs/github_payload
+
View
16 docs/jabber
@@ -1,18 +1,4 @@
-Jabber
-======
-
Install Notes
-------------
- 1. user is the Jabber ID (e.g.: myusername@jabber.org). Multiple users can be added by separating them with commas. Currently, there is a maximum of 25 users.
- 2. muc is the Jabber ID (e.g.: talks@conference.jabber.org/Nick). Multiple conferences can be added by separating them with commas.
-
-Developer Notes
----------------
-
-data
- - user
- - muc
-
-payload
- - refer to docs/github_payload
+ 1. **User** is the Jabber ID (e.g.: myusername@jabber.org). Multiple users can be added by separating them with commas. Currently, there is a maximum of 25 users.
View
25 docs/jaconda
@@ -1,25 +1,12 @@
-Jaconda
-========
-
Install Notes
-------------
+Pushes all Hooks for this Repository to Jaconda (Pushes, Issues, Pull Requests, etc).
+
Using the following url as an example:
https://bigbang.jaconda.im/rooms/galaxo
- 1. Subdomain is bigbang
- 2. Room ID is galaxo
- 3. Room token can be found on the Room Integration page
- 4. if Digest is checked, all commits will be compressed in one message
-
-Developer Notes
----------------
-
-data
- - subdomain
- - room_id
- - room_token
- - digest (boolean)
-
-payload
- - refer to docs/github_payload
+1. Subdomain is bigbang
+2. Room ID is galaxo
+3. Room token can be found on the Room Integration page
+4. if Digest is checked, all commits will be compressed in one message
View
8 docs/jenkins
@@ -0,0 +1,8 @@
+[Jenkins](http://jenkins-ci.org/) is a very popular Continious Integration Server
+
+Using the Jenkins GitHub Plugin you can automatically trigger build jobs directly from GitHub commits.
+
+Install Notes
+-------------
+
+ 1. github webhook url -- This this the url to your jenkins ci server for exmaple http://ci.jenkins-ci.org/github-webhook/. For more info, see https://wiki.jenkins-ci.org/display/JENKINS/Github+plugin for more details
View
15 docs/jenkins_github
@@ -1,15 +0,0 @@
-Jenkins (GitHub Plugin)
-=======================
-
-[Jenkins][] is a very popular Continuous Integration Server
-
-Using the [Jenkins GitHub Plugin][wiki] you can automatically trigger build jobs directly from GitHub commits.
-
-
-Install Notes
--------------
-
- 1. github webhook url -- This this the url to your jenkins ci server, for example http://ci.jenkins-ci.org/github-webhook/. See [the Github plugin wiki page][wiki] for more details.
-
-[jenkins]: http://jenkins-ci.org/ "Jenkins CI Server"
-[wiki]: https://wiki.jenkins-ci.org/display/JENKINS/Github+plugin
View
1  docs/jenkins_git → docs/jenkinsgit
@@ -28,3 +28,4 @@ Jenkins wiki for information.
[jenkins]: http://jenkins-ci.org/ "Jenkins CI Server"
[wiki]: https://wiki.jenkins-ci.org/display/JENKINS/Git+plugin
[wiki-push]: https://wiki.jenkins-ci.org/display/JENKINS/Git+plugin#GitPlugin-Pushnotificationfromrepository
+
View
28 docs/jira
@@ -1,11 +1,8 @@
-Jira
-========
-
This service hook allows you to transition Jira tickets using the REST API available in
version 4.2+ of Jira. To interact with tickets in Jira you will need to place markup
similar to Lighthouse's in your commit message.
- Fixed an annoying bug [#WEB-210 transition:31 resolution:1]
+ Fixed an annoying bug [#WEB-210 transition:31 resolution:1]
This will perform transition 31 with a resolution code of 1 on the issue WEB-210. You can specify
any key value pair with the `key:value` notation, but at the very least transition must be present.
@@ -15,26 +12,15 @@ versa.
Install Notes
-------------
+
A user in Jira will need to be created for GitHub. It should be given full
access to all projects.
Using the following url as an example:
-http://jira.enmasse.com/rest/2.0.alpha1/issue/WEB-249
-
- 1. http://jira.enmasse.com is the server_hostname
- 2. 2.0.alpha1 is the api_version
- 3. username of the GitHub user in Jira
- 4. password of the GitHub user in Jira
-
-
-Developer Notes
----------------
-data
- - server_url
- - api_version
- - username
- - password
+ http://jira.enmasse.com/rest/2.0.alpha1/issue/WEB-249
-payload
- - refer to docs/github_payload
+1. http://jira.enmasse.com is the server_hostname
+2. 2.0.alpha1 is the api_version
+3. username of the GitHub user in Jira
+4. password of the GitHub user in Jira
View
17 docs/kanbanery
@@ -1,18 +1,5 @@
-Kanbanery
-======
-
Install Notes
-------------
- 1. project token - Your project GitHub token from Kanbanery
- 2. project id
-
-Developer Notes
----------------
-
-data
- - project_token
- - project_id
-
-payload
- - refer to docs/github_payload
+1. project token - Your project GitHub token from Kanbanery
+2. project id
View
14 docs/kickoff
@@ -1,18 +1,4 @@
-Kickoff
-========
-
Install Notes
-------------
1. the project id and project token are available in the Kickoff app by right clicking on a project or through the API
-
-
-Developer Notes
----------------
-
-data
- - project_id
- - project_token
-
-payload
- - refer to docs/github_payload
View
5 docs/leanto
@@ -1,6 +1,3 @@
-Lean-to
-=======
-
The current version of Lean-To adds the ability to automatically link specific commits at GitHub with stories and bugs in your Lean-To projects. This feature is currently experimental and is only enabled for internal Refactr projects. If you would like access to this experimental feature please email support@lean-to.com.
Using the integration is as simple as tagging a Lean-To story or bug in your commit message:
@@ -28,8 +25,8 @@ GitHub integration is currently enabled for the **Milemarker**, **Lean-To**, **R
* Card properties do not need to be in any order as long as they follow the card identifier. So `[Story:1, iteration:2, estimate:1/2]` is valid, but `[status:completed, Story:1]` is not.
* Acceptable estimates are '0', '1/4', '0.25', '1/2', '0.5', '1', '2', '3', '5', '8', '13', '20', 40', and '80'. '0' will clear the estimate, and the rest will translate to their equivalent Lean-to estimate values.
-
Install Notes
-------------
1. Token - GitHub Service Hook Token for your Lean-to project. Get it by clicking "My Account" > "Projects & People" > "Enable API".
+
View
28 docs/lighthouse
@@ -1,29 +1,15 @@
-Lighthouse
-========
-
Install Notes
-------------
Using the following url as an example:
http://logicalawesome.lighthouseapp.com/projects/8570-github/overview
- 1. subdomain is logicalawesome
- 2. project_id is 8570
- 3. this service only supports project tokens
+ 1. **Subdomain** is logicalawesome
+ 2. **Project Id** is 8570
+ 3. This service only supports project tokens
(accepting patches for user-based tokens)
- 4. 'private' determines whether changed files
- should be displayed (useful for public LH
+ 4. **Private** determines whether changed files
+ should be displayed (useful for public LH
accounts and private GH repos)
-
-
-Developer Notes
----------------
-
-data
- - subdomain
- - project_id
- - token
- - private
-
-payload
- - refer to docs/github_payload
+ 5. **Send Only Ticket Commits** ensures that the only commits sent to
+ Lighthouse are ones with Lighthouse ticket codes.
View
14 docs/loggly
@@ -1,19 +1,7 @@
-Loggly
-========
-
This service hook allows you to log pushed commits directly to a Loggly HTTP
input.
Install Notes
-------------
- 1. input token -- take this from the detail page for your HTTP input.
-
-Developer Notes
----------------
-
-data
- - input_token
-
-payload
- - refer to docs/github_payload
+1. input token -- take this from the detail page for your HTTP input.
View
17 docs/mantis_bt → docs/mantisbt 100755 → 100644
@@ -1,22 +1,7 @@
-MantisBT
-========
-
Install Notes
-------------
Requires the Source Integration plugins from http://leetcode.net/projects/source-integration/
1. Base URL to MantisBT install
- 2. Secret API Key set at http://yoursite/mantis/plugin.php?page=Source/manage_config_page
-
-
-Developer Notes
----------------
-
-data
- - url
- - api_key
-
-payload
- - refer to docs/github_payload
-
+ 2. Secret API Key set at http://yoursite/mantis/plugin.php?page=Source/manage_config_page
View
20 docs/masterbranch
@@ -1,16 +1,4 @@
-Masterbranch
-========
-
-Install Notes
--------------
-
-With this service your commit's logs will be sent to Masterbranch.com . Masterbranch will proportionate you with an automatic-updated profile of your project. This profile will show the different technologies you are using, including some stats based on the contributors development.
-
-Developer Notes
----------------
-
-data
- - none
-
-payload
- - refer to docs/github_payload
+With this service your commit's logs will be sent to Masterbranch.com.
+Masterbranch will proportionate you with an automatic-updated profile of your
+project. This profile will show the different technologies you are using,
+including some stats based on the contributors development.
View
32 docs/mqtt
@@ -1,32 +0,0 @@
-MQTT
-========
-
-This service lets you publish push and commit messages to a message broker via the MQTT protocol.
-
-
-Install Notes
--------------
-
- 1. OPTIONAL. 'broker' is the hostname of the MQTT broker (default is q.m2m.io).
- 2. OPTIONAL. 'port' is the port to connect (default is 1883, MQTT standard).
- 3. 'topic' is the name of the topic to publish on. Suggested example: 'github/{github_username}/{repo_name} .
- 4. OPTIONAL. 'clientid' is the unique client ID which publishes the payload message (default is a prefixed epoc time long, e.g. "github_1336363787").
- 5. OPTIONAL. 'user' is the v3.1 username (default is none).
- 6. OPTIONAL. 'pass' is the v3.1 password (default is none).
- 7. The payload of the message is JSON received from Github (refer to docs/github_payload).
- 8. ruby-mqtt only supports QoS 0.
- 9. For testing, you can use mqtt.io as your web MQTT client. broker: q.m2m.io, port: 1883, clientid: {github_username}. You will "Subscribe to Topics": 'github/{github_username}/{repo_name}'. Unauthenticated username/password sets default to the public channel!
-
-Developer Notes
----------------
-
-data
- - broker
- - port
- - topic
- - clientid
- - user
- - pass
-
-payload
- - refer to docs/github_payload
View
18 docs/mqttpub
@@ -0,0 +1,18 @@
+MQTT
+========
+
+This service lets you publish push and commit messages to a message broker via the MQTT protocol.
+
+Install Notes
+-------------
+
+1. OPTIONAL. 'broker' is the hostname of the MQTT broker (default is q.m2m.io).
+2. OPTIONAL. 'port' is the port to connect (default is 1883, MQTT standard).
+3. 'topic' is the name of the topic to publish on. Suggested example: 'github/{github_username}/{repo_name} .
+4. OPTIONAL. 'clientid' is the unique client ID which publishes the payload message (default is a prefixed epoc time long, e.g. "github_1336363787").
+5. OPTIONAL. 'user' is the v3.1 username (default is none).
+6. OPTIONAL. 'pass' is the v3.1 password (default is none).
+7. The payload of the message is JSON received from Github (refer to docs/github_payload).
+8. ruby-mqtt only supports QoS 0.
+9. For testing, you can use mqtt.io as your web MQTT client. broker: q.m2m.io, port: 1883, clientid: {github_username}. You will "Subscribe to Topics": 'github/{github_username}/{repo_name}'. Unauthenticated username/password sets default to the public channel!
+
View
12 docs/notifymyandroid → docs/nma
@@ -1,6 +1,3 @@
-Notify My Android
-==========
-
With NotifyMyAndroid (NMA) you can push notifications to your Android devices
through Google's C2DM notification system. The [public Web API](http://www.notifymyandroid.com/api.php)
can be used by virtually any application to delivery push notifications to
@@ -12,12 +9,3 @@ Install Notes
1. Register at https://www.notifymyandroid.com/register.php.
2. Generate an API key at https://www.notifymyandroid.com/account.php to be used on GitHub.
-
-Developer Notes
----------------
-
-apikey
- - Your NMA API Key, or a CSV list of API Keys.
-
-payload
- - refer to docs/github_payload
View
11 docs/nodejitsu
@@ -16,14 +16,3 @@ Install Notes
3. Check the "Active" checkbox and click "Update Settings".
4. Click on the "Nodejitsu" service name and then click the "Test Hook" link.
-For more details about Nodejitsu, go to http://nodejitsu.com.
-If you want to know if your deploy was successful or why it failed please refer to out [API documentation of the Nodejitsu Web-hook API](http://webhooks.nodejitu.com)
-
-Developer Notes
----------------
-
-data
- - password
- - username
- - domain
- - branch
View
22 docs/notifo
@@ -1,23 +1,11 @@
-Notifo
-==========
-
-This service lets your broadcast your commits on Notifo, a mobile notifications platform. Get commit notifications on your iPhone and other mobile devices immediately via PUSH. Notifo also OS X, Linux and Windows notification apps. If multiple commits are in a push you will be shown the last with a message stating how many more exist, and a link to the compare url.
-
Install Notes
-------------
- 1. Create a user account on Notifo at https://notifo.com/register
- 2. Type in your username and the usernames of others wanting to be notified of commits to this repository with Notifo into the subscribers field.
- 3. Enjoy.
-
-Notifications are only sent after the service (GitHub) has been approved to send you notifications on Notifo. This happens after the first commit after this service is enabled. You will begin receiving commit notifications from then on.
-
+This service lets your broadcast your commits on Notifo, a mobile notifications platform. Get commit notifications on your iPhone and other mobile devices immediately via PUSH.
-Developer Notes
----------------
-data
- - subscribers (csv list of up to 25 Notifo usernames)
+ 1. Create a user account on Notifo at <https://notifo.com/user/register>
+ 2. Type in your username and the usernames of others wanting to be notified of commits to this repository with Notifo into the subscribers field (comma separated).
+ 3. Enjoy.
-payload
- - refer to docs/github_payload
+Notifications are only sent after the service (GitHub) has been approved to send you notifications on Notifo. This happens after the first commit after this service is enabled. You will begin receiving commit notifications from then on.
View
13 docs/ontime
@@ -1,14 +1,14 @@
-OnTime GitHub Integration
-=========================
-
Install Notes
-------------
In order to properly configure OnTime and GitHub to work together a few settings have to be configured.
1. Log into your OnTime v11.1+ installation as the Administrator or with a user that has System Options privledges.
+
2. Open up the "Tools" menu and click on "System Options" and then go to the "GitHub Integration" option in the left pane.
+
3. Make sure that "Enable GitHub Integration" is checked and that an API Key exists. If it doesn't then click "Generate a New API Key" to make one
+
4. Copy the API key and paste that into the OnTime service hook in your GitHub repository.
NOTE: If you have a non-hosted installation of OnTime your installation must have access to the internet. Hosted accounts already have internet access.
@@ -43,10 +43,3 @@ A few examples of valid tags (assuming you have hours as a timeunit in OnTime an
[oti: srx0091]
-Developer Notes
----------------
-
-data
- - ontime_url
- - api_key
-
View
11 docs/pachube
@@ -12,14 +12,3 @@ Install Notes
1. Create a feed on [Pachube](https://pachube.com/).
2. Create an api key that has PUT permissions on the feed.
-
-Developer Notes
----------------
-
-data
- - api_key
- - feed_id
- - track_branch
-
-payload
- - refer to docs/github_payload
View
11 docs/packagist
@@ -3,7 +3,6 @@ Packagist
Packagist – the main Composer repository
-
Install Notes
-------------
@@ -18,13 +17,3 @@ Install Notes
For more details about Packagist, visit http://packagist.org/
-
-Developer Notes
----------------
-
-data
- - token
- - user
- - domain
-
-The token has to belong to the user, of course.
View
18 docs/pivotal_tracker
@@ -1,18 +0,0 @@
-Pivotal Tracker
-===============
-
-Install Notes
--------------
-
- 1. token is your Pivotal Tracker API Token. This is at the bottom of your 'My Profile' page.
- 2. branch is a space-separated list of the branches you want to listen for commits on. If none is provided it will listen on all branches.
-
-Developer Notes
----------------
-
-data
- - token
- - branch
-
-payload
- - refer to docs/github_payload
View
6 docs/pivotaltracker
@@ -0,0 +1,6 @@
+Install Notes
+-------------
+
+1. "token" is your Pivotal Tracker API Token. This is at the bottom of your 'My Profile' page.
+2. "branch" is the name of the branch you want to listen for commits on. If none is provided it will listen on all branches.
+3. "endpoint" is an optional endpoint for a custom Pivotal Tracker installation. Leave this blank to use "https://www.pivotaltracker.com".
View
15 docs/planbox
@@ -1,12 +1,5 @@
-Planbox
-=======
+Install Notes
+-------------
-token is your Planbox Inititative Token. Find in on the Manage page.
-
-payload contains the commit data; same as you get when using API. See docs/github_payload.
-
-TEST
-----
-
-svc = Service::Planbox.new(:push, {'token' => '223cazxbs97de1ndj61d8aa435b0o9i05'})
-svc.receive_push
+ 1. The token is your Planbox Inititative Token. Find in on the Manage page.
+ 2. More information available on Planbox's <a href="http://www.planbox.com/start/help/scm_integration#github">help site</a>.
View
21 docs/presently
@@ -1,21 +1,6 @@
-Present.ly
-==========
-
Install Notes
-------------
- 1. subdomain (for a Present.ly account)
- 2. group_name (OPTIONAL; will broadcast as a group or as the system if group is 'system')
- 3. username (user must be a manager of the specified group or admin for 'system')
-
-Developer Notes
----------------
-
-data
- - subdomain
- - group_name (optional)
- - username
- - password
-
-payload
- - refer to docs/github_payload
+ 1. **Subdomain** (for a Present.ly account)
+ 2. **Group Name** (OPTIONAL; will broadcast as a group or as the system if group is 'system')
+ 3. **Username** (user must be a manager of the specified group or admin for 'system')
View
14 docs/prowl
@@ -1,6 +1,3 @@
-Prowl
-==========
-
Prowl is an iPhone App+Web Service for arbitrary Push Notifications. After installing the app and registering the device, you receive an API key and can send notifications from your computer via Growl (with the Prowl GrowlStyle installed) or from any server with very little work (at least as far as the Push submission is concerned).
To get started, create a user account for Prowl at https://www.prowlapp.com/.
@@ -8,13 +5,4 @@ To get started, create a user account for Prowl at https://www.prowlapp.com/.
Install Notes
-------------
-1. Create a new API key for GitHub at the Prowl website https://www.prowlapp.com/api_settings.php.
-
-Developer Notes
----------------
-
-apikey
- - Your Prowl API key.
-
-payload
- - refer to docs/github_payload
+1. Create a new API key for GitHub at the [Prowl website](https://www.prowlapp.com/api_settings.php).
View
11 docs/pushover
@@ -1,5 +1,5 @@
Pushover
-==========
+========
Pushover is a cross-platform push notification service with a [simple API](https://pushover.net/api).
@@ -12,12 +12,3 @@ Install Notes
3. Add your user key in the field above. Optionally enter a device name to have notifications go to a single device, or leave blank to send to all active devices on your account.
-Developer Notes
----------------
-
-data
- - user_key
- - device_name
-
-payload
- - refer to docs/github_payload
View
9 docs/railsbp
@@ -15,12 +15,3 @@ Install Notes
For more details about Railsbp, go to https://railsbp.com
-Developer Notes
----------------
-
-data
- - railsbp_url
- - token
-
-payload
- - refer to docs/github_payload
View
0  docs/rails_brakeman → docs/railsbrakeman
File renamed without changes
View
44 docs/rally
@@ -30,30 +30,20 @@ NB: Uri fields in Rally Changeset/Change records refer the to master branch.
Install Notes
-------------
- You'll need a Rally account (see http://rally.rallydev.com).
-
- 1. server - (REQUIRED) is the hostname of the Rally server.
- You do not have to provide the domain name portion of the server
- if the name of the server is a Rally SaaS server,
- ie., rally1 or trial or demo.
- If you are utilizing the Rally OnPrem product, you'll need
- to provide fully qualified hostname.
- 2. username - (REQUIRED) is the Rally UserName for the subscription.
- Make sure you specify the UserName (not the DisplayName or FirstName and LastName or Email).
- 3. password - (REQUIRED) is the password associated with the UserName for the Rally Subscription.
- 4. workspace - (REQUIRED) is the name of the Rally Workspace in which the target SCMRepository
- resides.
- 5. repository - (OPTIONAL) is the name of the Rally SCMRepository. By default, if not provided,
- this integration will use the name of your GitHub repository as the SCMRepository name.
- But, you have the ability to name the Rally SCMRepository to your choice of a name.
-
-
-Developer Notes
-----------------
-
-data
- - server (Rally server name (domain info optional))
- - username (Rally subscription UserName)
- - password (Rally subscription Password )
- - workspace (name of Rally workspace holding target repository)
- - repository (name of Rally SCMRepository (defaults to GitHub repository name))
+You'll need a Rally account (see http://rally.rallydev.com).
+
+1. server - (REQUIRED) is the hostname of the Rally server.
+ You do not have to provide the domain name portion of the server
+ if the name of the server is a Rally SaaS server,
+ ie., rally1 or trial or demo.
+ If you are utilizing the Rally OnPrem product, you'll need
+ to provide fully qualified hostname.
+2. username - (REQUIRED) is the Rally UserName for the subscription.
+ Make sure you specify the UserName (not the DisplayName or FirstName and LastName or Email).
+3. password - (REQUIRED) is the password associated with the UserName for the Rally Subscription.
+4. workspace - (REQUIRED) is the name of the Rally Workspace in which the target SCMRepository
+ resides.
+5. repository - (OPTIONAL) is the name of the Rally SCMRepository. By default, if not provided,
+ this integration will use the name of your GitHub repository as the SCMRepository name.
+ But, you have the ability to name the Rally SCMRepository to your choice of a name.
+
View
15 docs/rdocinfo
@@ -1,15 +1,2 @@
-rubydoc.info
-=========
-
This service allows you to auto-publish documentation for your Ruby gem or library.
-The resulting documentation will be hosted for you at http://rubydoc.info/github/your-name/your-project
-
-
-Developer Notes
----------------
-
-data
- - (no data is required, payload is simply posted to http://rubydoc.info/checkout)
-
-payload
- - refer to docs/github_payload
+The resulting documentation will be hosted for you at http://rubydoc.info/github/your-name/your-project
View
15 docs/read_the_docs
@@ -1,15 +0,0 @@
-ReadTheDocs
-===========
-
-Automatically build documentation hosted on readthedocs.org.
-
-
-Developer Notes
----------------
-
-data
- - (no data required; payload is sent to http://readthedocs.org/github)
-
-payload
- - refer to docs/github_payload
-
View
1  docs/readthedocs
@@ -0,0 +1 @@
+Automatically build documentation hosted on readthedocs.org.
View
30 docs/rubyforge
@@ -1,30 +1,6 @@
-RubyForge
-=========
-
-Special Thanks
--------------
-
-Would like to notice Ara Howard and his RubyForge gem, from which I copied most of the code
-used in this service. Would also like to notice the author of the Basecamp service, since
-I used that service as a template for the RubyForge service.
-
-This service simply posts a new NewsByte to the RubyForge project (as specified by the groupid).
-
Install Notes
-------------
- 1. username should be the username of a user that has access to the RubyForge project
- 2. password should be the password of the given user
- 3. groupid should be the group id of the RubyForge project
-
-
-Developer Notes
----------------
-
-data
- - username
- - password
- - groupid
-
-payload
- - refer to docs/github_payload
+ 1. **Username** should be the username of a user that has access to the RubyForge project
+ 2. **Password** should be the password of the given user
+ 3. **Group Id** should be the group id of the RubyForge project
View
13 docs/scrumdo
@@ -1,6 +1,3 @@
-ScrumDo
-=======
-
ScrumDo is an agile/scrum project management site found at http://www.scrumdo.com
Integrating GitHub with ScrumDo lets you see commits in your project newsfeed, and allows you to update stories via commit messages.
@@ -22,13 +19,3 @@ Install Notes
Your project slug is `acme-project`
-Developer Notes
----------------
-
-data
- - username
- - password
- - project_slug
-
-payload
- - refer to docs/github_payload
View
22 docs/shiningpanda
@@ -10,21 +10,9 @@ See https://www.shiningpanda.com for more information.
Install Notes
-------------
- 1. Workspace - This your workspace key. For instance if your Jenkins URL is https://jenkins.shiningpanda.com/shiningpanda.org, then your workspace key is "shiningpanda.org".
- 2. Job - This is the name of the job you want to trigger upon commit. For instance if the URL of your job in Jenkins is https://jenkins.shiningpanda.com/shiningpanda.org/job/selenose/, then your job name is selenose.
- 3. Token - This is the value of the "Authentication Token" field of the "Trigger builds remotely (e.g., from scripts)" option in the "Build Triggers" section of your job configuration.
- 4. Branches (optional) - This is a space-separated list of branches to listen for commits on. Commits to other branches will not trigger your job. If no branches are specified, jobs are triggered for all commits.
- 5. Parameters (optional) - If your job takes parameters, this is the query string built from the parameters and their value (for instance "arg1=foo&arg2=bar"). All parameters have to be properly URL-escaped.
+1. Workspace - This your workspace key. For instance if your Jenkins URL is https://jenkins.shiningpanda.com/shiningpanda.org, then your workspace key is "shiningpanda.org".
+2. Job - This is the name of the job you want to trigger upon commit. For instance if the URL of your job in Jenkins is https://jenkins.shiningpanda.com/shiningpanda.org/job/selenose/, then your job name is selenose.
+3. Token - This is the value of the "Authentication Token" field of the "Trigger builds remotely (e.g., from scripts)" option in the "Build Triggers" section of your job configuration.
+4. Branches (optional) - This is a space-separated list of branches to listen for commits on. Commits to other branches will not trigger your job. If no branches are specified, jobs are triggered for all commits.
+5. Parameters (optional) - If your job takes parameters, this is the query string built from the parameters and their value (for instance "arg1=foo&arg2=bar"). All parameters have to be properly URL-escaped.
-Developer Notes
----------------
-
-data
- - workspace
- - job
- - token
- - branches (optional)
- - parameters (optional)
-
-payload
- - refer to docs/github_payload
View
7 docs/slatebox
@@ -7,8 +7,9 @@ Use this service to create and manage new apps that live in the Slatebox environ
Install Notes
-------------
- 1. Log into Slatebox and find your "developer deployment key" in your developer dashboard. Note: this is NOT the same thing as your API key or secret key. Paste this key into the above "token" textfield.
+1. Log into Slatebox and find your "developer deployment key" in your developer dashboard. Note: this is NOT the same thing as your API key or secret key. Paste this key into the above "token" textfield.
- 2. "App Id" is a list of unique application names separated by "," (i.e. "foo" or "foo,bar") that inform Slatebox what application(s) should build when this repository is updated. In order to get an app identifier, simply create the app first in your Slatebox developer dashboard and paste it into the "App Id" textfield above.
+2. "App Id" is a list of unique application names separated by "," (i.e. "foo" or "foo,bar") that inform Slatebox what application(s) should build when this repository is updated. In order to get an app identifier, simply create the app first in your Slatebox developer dashboard and paste it into the "App Id" textfield above.
+
+3. If your GitHub repository is private you need to add the "slatebox" GitHub user as a collaborator. This enables Slatebox to download the source code.
- 3. If your GitHub repository is private you need to add the "slatebox" GitHub user as a collaborator. This enables Slatebox to download the source code.
View
11 docs/snowyevening
@@ -11,14 +11,3 @@ Install Notes
3. Find the GitHub integration box, which contains the API Key and Project ID
4. Copy those credentials into these fields.
-
-
-Developer Notes
----------------
-
-data
- - api_key (the API key for using the webservice)
- - project (identifier of the project belonging to this repository)
-
-payload
- - refer to docs/github_payload (nothing is used by this script)
View
30 docs/socialcast
@@ -1,26 +1,8 @@
-Socialcast
-==========
+You should already have a Socialcast community. For the group_id you'll need to
+call the API to figure out the underlying integer group id for a group.
-Install Notes
--------------
+1. api_domain (e.g. foo-com.socialcast.com)
+2. username (user to post message on behalf of)
+3. password (password of user to post message on behalf of)
+4. group_id (OPTIONAL Id of a Socialcast group to post the message into)
- You should already have a Socialcast community. For the group_id you'll need to call the
- API to figure out the underlying integer group id for a group.
-
-
- 1. api_domain (e.g. foo-com.socialcast.com)
- 2. username (user to post message on behalf of)
- 3. password (password of user to post message on behalf of)
- 4. group_id (OPTIONAL Id of a Socialcast group to post the message into)
-
-Developer Notes
----------------
-
-data
- - api_domain
- - username
- - password
- - group_id (optional)
-
-payload
- - refer to docs/github_payload
View
4 docs/sourcemint
@@ -1,5 +1,3 @@
-Sourcemint
-==========
-
Notify the [Sourcemint](http://sourcemint.com/) package repository and build service when a new release has been tagged
or changes have been pushed to a branch.
+
View
12 docs/splendid_bacon → docs/splendidbacon
@@ -5,14 +5,4 @@ Install Notes
-------------
1. Token is your project token from Splendid Bacon. This is found on the project edit page on http://splendidbacon.com
- 2. Project ID is a unique identifier for your project. This is found on the project edit page or in any URL for the project.
-
-Developer Notes
----------------
-
-data
- - token
- - project_id
-
-payload
- - refer to docs/github_payload
+ 2. Project ID is a unique identifier for your project. This is found on the project edit page or in any URL for the project.
View
10 docs/sqs_queue → docs/sqsqueue
@@ -9,13 +9,3 @@ SqsQueue allows Github to send a notification to a queue inside your Amazon AWS
1. Configure your Amazon AWS account with an appropriately set up access-key/secret-key (Either parent account or IAM)
that has permissions to perform 'SendMessage' operations. (https://console.aws.amazon.com/sqs/)
-Developer Notes
----------------
-
-data
- - aws_access_key (String)
- - aws_secret_key (String)
- - sqs_queue_name (String)
-
-payload
- - refer to docs/github_payload
View
11 docs/stackmob
@@ -1,6 +1,3 @@
-StackMob Deploy
-==============
-
Deploys this Repository to StackMob after each push.
Install Notes:
@@ -8,11 +5,3 @@ Install Notes:
1. Token - Your [StackMob GitHub Token](https://stackmob.com/platform/account/versioncontrol/settings)
-Developer Notes
----------------
-
-data
- - token
-
-payload
- - refer to docs/github_payload
View
18 docs/statusnet
@@ -1,20 +1,4 @@
-Statusnet (laconica)
-====================
-
Install Notes
-------------
- 1. the server field should be the server base URI.(eg. http://identi.ca or http://identi.ca/index.php)
-
-
-Developer Notes
----------------
-
-data
- - username
- - password
- - digest (boolean)
- - server
-
-payload
- - refer to docs/github_payload
+ 1. **Server** should be the server base URI.(eg. http://identi.ca or http://identi.ca/index.php)
View
22 docs/talker
@@ -1,22 +1,8 @@
-Talker
-========
-
Install Notes
-------------
- 1. url should be your room url, for example https://youraccount.talkerapp.com/rooms/ROOM_ID
- 2. token should be on your settings page
- 3. if digest is checked, all commits will be compressed in one message
-
-Note: replace https with http on the url if you're on the Free plan as it doesn't include enhanced security (SSL).
-
-Developer Notes
----------------
-
-data
- - url
- - token
- - digest (boolean)
+ 1. **Url** should be your room url, for example https://youraccount.talkerapp.com/rooms/ROOM_ID
+ 2. **Token** should be on your settings page
+ 3. If **Digest** is checked, all commits will be compressed in one message
-payload
- - refer to docs/github_payload
+Note: replace https with http on the url if you're on the Free plan as it doesn't include enhanced security (SSL).
View
23 docs/target_process → docs/targetprocess
@@ -1,10 +1,3 @@
-TargetProcess
-=============
-
--------------------------------------------
-TargetProcess - GitHub Integration Overview
--------------------------------------------
-
Integration with TargetProcess allows GitHub user to change current entity states
and add comments directly from their commit messages.
@@ -38,23 +31,11 @@ Commit Message Syntax
General comment format for adding comments and/or changing entity states:
- #[Entity ID]:<new state>
- Eg: Fixed out of memory exceptions #1221:Fixed
+ #[Entity ID]:<new state>
+ Eg: Fixed out of memory exceptions #1221:Fixed
The entire line will appear as a comment in your User Story, Bug, Feature, or Task; and the entity's
state will be changed to the state name, if specified. A new state is not required, and an
Assignable's state will not change unless it is specified. Entity ID is required. This
text sequence can appear anywhere in your commit message.
-
-
-Developer Notes
----------------
-
-data
--base_url
--username
--password
--project_id
-
-
View
6 docs/test_pilot → docs/testpilot
@@ -19,9 +19,3 @@ Install Notes
For more details about TestPilot, go to http://testpilot.me
-Developer Notes
----------------
-
-data
- - token
-
View
24 docs/toggl
@@ -1,20 +1,4 @@
-toggl
-========
-
-Install Notes
--------------
-
- 1. API Key: Your toggl api key. (Get it at https://www.toggl.com/user/edit)
- 2. Project: the id of the toggl project that this repo links to
- 3. Activate and go!
- 4. To track your time simply add t:number-of-minutes (integer) to your commit message
-
-Developer Notes
----------------
-
-data
- - api_key
- - project
-
-payload
- - refer to docs/github_payload
+1. API Key: Your toggl api key. (Get it at https://www.toggl.com/user/edit)
+2. Project: the id of the toggl project that this repo links to
+3. Activate and go!
+4. To track your time simply add t:number-of-minutes (integer) to your commit message
View
25 docs/trac
@@ -1,20 +1,19 @@
-Trac
-====
-
Install the following plugin on your Trac server before proceeding: http://github.com/davglass/github-trac/
- 1. url field is your Trac install's url
- 2. token (this needs to be the same token you put in your trac.ini installed via the plugin)
+ 1. **Url** is your Trac install's url
+ 2. **Token** (this needs to be the same token you put in your trac.ini installed via the plugin)
The plugin searches commit messages for text in the form of:
- command #1
- command #1, #2
- command #1 & #2
- command #1 and #2
+
+ * command #1
+ * command #1, #2
+ * command #1 & #2
+ * command #1 and #2
Instead of the short-hand syntax "#1", "ticket:1" can be used as well, e.g.:
- command ticket:1
- command ticket:1, ticket:2
- command ticket:1 & ticket:2
- command ticket:1 and ticket:2
+
+ * command ticket:1
+ * command ticket:1, ticket:2
+ * command ticket:1 & ticket:2
+ * command ticket:1 and ticket:2
View
5 docs/trajectory
@@ -4,6 +4,7 @@ Trajectory
Install Notes
-------------
- 1. api_key: Your api key can be found in this link: https://www.apptrajectory.com/profile/edit
+1. api_key: Your api key can be found in this link: https://www.apptrajectory.com/profile/edit
+
+All you need to do is copy your api key from the application and paste it into the GitHub service configuration.
-All you need to do is copy your api key from the application and paste it into the GitHub service configuration.
View
33 docs/travis
@@ -1,30 +1,13 @@
-Travis
-======
-
-Travis – a distributed continuous integration service for the open source community
-
-
Install Notes
-------------
- 1. Create an account at http://travis-ci.org (you can sign in with GitHub)
- 2. Enter your credentials
- - The token which you can find on the Travis profile page
- - optional: Enter the username who the Travis token belongs to (defaults to the repository owner)
- - optional: Enter the host of your Travis installation (defaults to http://notify.travis-ci.org), the protocol-prefix is optional and defaults to "http://".
- 3. Make sure the "Active" checkbox is ticked, and click "Update Settings".
- 4. Click on the "Travis" service name and then click the "Test Hook" link.
- 5. You should receive an email from Travis once the build has completed
+1. Create an account at http://travis-ci.org (you can sign in with GitHub)
+2. Enter your credentials
+ - The token which you can find on the Travis profile page
+ - optional: Enter the username who the Travis token belongs to (defaults to the repository owner)
+ - optional: Enter the host of your Travis installation (defaults to http://notify.travis-ci.org), the protocol-prefix is optional and defaults to "http://".
+3. Make sure the "Active" checkbox is ticked, and click "Update Settings".
+4. Click on the "Travis" service name and then click the "Test Hook" link.
+5. You should receive an email from Travis once the build has completed
For more details about Travis, go to http://about.travis-ci.org/docs/
-
-
-Developer Notes
----------------
-
-data
- - token
- - user
- - domain
-
-The token has to belong to the user, of course.
View
13 docs/trello
@@ -15,16 +15,3 @@ Install Notes
4. If you only want to create cards for commits on the master branch, tick 'Master Only'
[create]: https://trello.com/1/authorize?key=db1e35883bfe8f8da1725a0d7d032a9c&name=Github+Services&expiration=never&response_type=token&scope=read,write
-
-Developer Notes
----------------
-
-data
- - consumer_token
- - list_id
- - ignore_regex
- - master_only
-
-payload
- - refer to docs/github_payload
-
View
19 docs/twilio
@@ -1,10 +1,7 @@
-Twilio
-======
-
Allows you to setup a GitHub repository to send out SMS messages on git pushes.
Currently the SMS message is built to say:
-[pusher name] has pushed [# commits] commit(s) to [repository name]
+ "#{payload['pusher']['name']} has pushed #{payload['commits'].size} commit(s) to #{payload['repository']['name']}"
Install Notes
-------------
@@ -13,17 +10,5 @@ Install Notes
2. You can find your account_sid and auth_token on your account page at https://www.twilio.com/user/account
3. from_phone must be a "Twilio phone number enabled for SMS. Only phone numbers or short codes purchased from Twilio work here"
4. to_phone is the "destination phone number. Format with a '+' and country code e.g., +16175551212 (E.164 format)."
-5. Check master_only if you only want to recieve updates for master
-
-Developer Notes
----------------
-
-data
- - account_sid
- - auth_token
- - from_phone
- - to_phone
- - master_only
+5. Check master_only if you only want to recieve updates for master.
-payload
- - refer to docs/github_payload
View
29 docs/twitter
@@ -1,29 +1,8 @@
-Twitter
-========
-
Install Notes
-------------
-1. Get an OAuth Token for Your Twitter Account from the services hooks edit page for your repo.
-2. You're going to be redirected to twitter to allow GitHub to tweet on your behalf.
-3. Be sure that you're logged in as the twitter user you would like to tweet from.
-
-Developer Notes
----------------
-
-data
- - token
- - secret
- - digest (boolean)
-
-payload
- - refer to docs/github_payload
-
-Deployment Notes
-----------------
-
-The secrets.yml file should include an entry for the consumer keys github needs to post for people.
+ 1. [Get an OAuth Token for Your Twitter Account][authorize_url].
+ 2. You're going to be redirected to twitter to allow GitHub to tweet on your behalf.
+ 3. Be sure that you're logged in as the twitter user you would like to tweet from.
- twitter:
- key: <get it from twitter>
- secret: <get it from twitter>
+[authorize_url]: <%= twitter_oauth_path(current_repository.user, current_repository) %>
View
23 docs/unfuddle
@@ -1,30 +1,17 @@
-Unfuddle
-========
-
Unfuddle is a lovely ticket management, time tracking, project hosting service.
Install Notes
---------------
-Create a new Git repository in your Unfuddle project.
-Once created, edit the repository settings. Check the
+Create a new Git repository in your Unfuddle project.
+Once created, edit the repository settings. Check the<