diff --git a/.github/docs/debug-settings.png b/.github/docs/debug-settings.png new file mode 100644 index 0000000000..8bf080cee4 Binary files /dev/null and b/.github/docs/debug-settings.png differ diff --git a/.github/docs/debugger.png b/.github/docs/debugger.png new file mode 100644 index 0000000000..2e0aa3bf19 Binary files /dev/null and b/.github/docs/debugger.png differ diff --git a/.github/docs/listening-debugger.png b/.github/docs/listening-debugger.png new file mode 100644 index 0000000000..48082e58f0 Binary files /dev/null and b/.github/docs/listening-debugger.png differ diff --git a/.github/docs/mappings.png b/.github/docs/mappings.png new file mode 100644 index 0000000000..e68a368bc4 Binary files /dev/null and b/.github/docs/mappings.png differ diff --git a/.github/docs/phabricator-includes.png b/.github/docs/phabricator-includes.png new file mode 100644 index 0000000000..4f7fd57529 Binary files /dev/null and b/.github/docs/phabricator-includes.png differ diff --git a/README.md b/README.md index 2ec044ddd3..bdcbbca14b 100644 --- a/README.md +++ b/README.md @@ -71,19 +71,19 @@ PHPStorm as the example IDE, though any Xdebug-compatible app should work. 1. Uncheck the "Notify if debug session was finished without being paused" option so that PhpStorm doesn't continually pop up a notification if web requests succeed without hitting a breakpoint. This allows background requests (fetching resources, `bmo.feed` requests, etc) to function without triggering warnings. - ![](docs/debug-settings.png) + ![](.github/docs/debug-settings.png) 1. Configure your source mappings from your host's directories to your server's (docker container's) directories 1. It's recommended to have the `arcanist` and `phabricator` source code in your PHP's includes - so that you can step into (debug) and Intellisense the vendor code ![](docs/phabricator-includes.png) + so that you can step into (debug) and Intellisense the vendor code ![](.github/docs/phabricator-includes.png) * This can be set up by cloning [phabricator](https://github.com/phacility/phabricator) and [arcanist](https://github.com/phacility/arcanist), then checking out the appropriate commits as defined in this repository's `Dockerfile`. - 1. Create a new "server" configuration with the host as `phabricator.test` and the path mappings as shown below: ![](docs/mappings.png) + 1. Create a new "server" configuration with the host as `phabricator.test` and the path mappings as shown below: ![](.github/docs/mappings.png) 1. Test your mappings - 1. Enable the debugger in PhpStorm ![](docs/listening-debugger.png) + 1. Enable the debugger in PhpStorm ![](.github/docs/listening-debugger.png) 1. Set a breakpoint in `LandoLinkEventListener` 1. Go to [`phabricator.test/D1`](http://phabricator.test/D1) - 1. Your IDE should have stopped the control flow on your breakpoint and be showing you debugger details ![](docs/debugger.png) + 1. Your IDE should have stopped the control flow on your breakpoint and be showing you debugger details ![](.github/docs/debugger.png) ##### My pages are no longer loading after enabling debugging!? @@ -107,5 +107,5 @@ docker-compose -f docker-compose.yml -f docker-compose.bmo.yml exec phabdb mysql ## Support -To talk to the `phabricator-extensions` developers, you can join them on [Matrix](https://chat.mozilla.org/#/room/#conduit:mozilla.org). +To talk to the Mozilla `phabricator` developers, you can join them on [Matrix](https://chat.mozilla.org/#/room/#conduit:mozilla.org). diff --git a/composer.json b/composer.json index 90a852289a..577d7034ea 100644 --- a/composer.json +++ b/composer.json @@ -1,5 +1,5 @@ { - "name": "mozilla/phabricator-extensions", + "name": "mozilla/phabricator", "type": "project", "require": { "sentry/sentry": "^2.3",