search

sourcegraph / sourcegraph-public-snapshot

Code AI platform with Code Search & Cody
https://sourcegraph.com
Other
10.11k stars 1.29k forks source link

docs: phabricator external service's configuration example isn't helpful #4075

Open ggilmore opened 5 years ago

ggilmore commented 5 years ago
  1. Run the https://github.com/sourcegraph/sourcegraph/releases/tag/v3.4.0-rc.4 Docker image via https://github.com/sourcegraph/sourcegraph/blob/master/dev/run-server-image.sh: IMAGE=sourcegraph/server:3.4.0-rc.4 ./dev/run-server-image.sh
  2. Create an admin account
  3. Click the button to a new Phabricator external service

The configuration editor's default contents are only filled in with empty values (and no comments), which doesn't help you figure out how to set the configuration properly:

Screen Shot 2019-05-16 at 4 41 18 PM

The example in https://docs.sourcegraph.com/admin/external_service/phabricator#configuration also only contains empty values.

Compare this to Github external service configuration editor:

Screen Shot 2019-05-16 at 4 44 33 PM

This editor has tons of examples in the comments that tell you what the expected values should be for each key.

slimsag commented 5 years ago

cc @ryan-blunden since you recently updated these, not sure if applicable to you or not.

ryan-blunden commented 5 years ago

Thanks for the feedback @ggilmore.

Phabricator will be revised for 3.5, as will Gitolite. Tracking issue #4021