Skip to content

Commit

Permalink
Merge pull request #69 from gtardif/dev_debug_docs
Browse files Browse the repository at this point in the history
Add doc for systematically opening chrome dev tools while developing a specific extension
  • Loading branch information
gtardif authored Jan 24, 2022
2 parents e20d670 + 2dff4f7 commit 3a4604c
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion docs/dev/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,19 @@ For further inspiration, have a look at the rest of examples in the root of this
Once an extension is deployed and running, it is possible to open the Chrome Dev Tools from the UI extension part, using a variation of the [Konami Code](https://en.wikipedia.org/wiki/Konami_Code).
Click on the extension tab, and then hit the key sequence `up, up, down, down, left, right, left, right, p, d, t`. That should open Dev Tools, and give access to the Chrome console, debugger, etc.

Or, if you want to systematically open the Chrome Dev Tools for your extension whitout typing a knoami code, you can run

```console
docker extension dev debug my-extension
```

Each click on the extension tab will then also open Chrome Dev Tools.
You can stop this behaviour with

```console
docker extension dev reset my-extension
```

### Developing the Extension UI

If your extension has a UI you can see it directly inside Docker Desktop while developing it.
Expand All @@ -33,7 +46,7 @@ This will change the source of the extension UI to your local development server

Make sure to reopen the Dashboard when you set a new source for the extension's UI.

Once finished, you can reset the extension configuration to the original settings:
Once finished, you can reset the extension configuration to the original settings (note htis will also reset opening chrome dev tools if you used `docker extension dev debug my-extension`):

```console
docker extension dev reset my-extension
Expand Down

0 comments on commit 3a4604c

Please sign in to comment.