Permalink
Browse files

update docs to new format. remove developer notes

  • Loading branch information...
1 parent 3d9fd62 commit 7749de12298e3ee8d52601e56414de9152015b36 @technoweenie technoweenie committed Jun 18, 2012
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
@@ -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
@@ -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
@@ -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.
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
Oops, something went wrong.

1 comment on commit 7749de1

@Jessica1118

thanks

Please sign in to comment.