Skip to content

Commit

Permalink
integrations: Update docs for adding integration images.
Browse files Browse the repository at this point in the history
  • Loading branch information
synicalsyntax authored and timabbott committed Apr 25, 2017
1 parent 6cb03ea commit a267c61
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
15 changes: 11 additions & 4 deletions docs/integration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,10 +221,17 @@ Usually, this involves a few steps:

* Make sure you've added your integration to
`zerver/lib/integrations.py`; this results in your integration
appearing on the `/integrations` page. You'll need to add a logo
image for your integration under the
`static/images/integrations/logos/<name>.png`, where `<name>` is the
name of the integration, all in lower case.
appearing on the `/integrations` page.

* You'll need to add a SVG graphic
of your integration's logo under the
`static/images/integrations/logos/<name>.svg`, where `<name>` is the
name of the integration, all in lower case; you can usually find them in the
product branding or press page. Make sure to optimize the SVG graphic by
running `svgo -f path-to-file`.

If you cannot find a SVG graphic of the logo, please find and include a PNG
image of the logo instead.

* Finally, generate a message sent by the integration and take a
screenshot of the message to provide an example message in the
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
"jsdom": "9.4.1",
"nwmatcher": "1.3.6",
"phantomjs-prebuilt": "2.1.14",
"svgo": "0.7.2",
"webpack-dev-server": "1.12.1",
"xmlhttprequest": "1.5.0"
},
Expand Down

0 comments on commit a267c61

Please sign in to comment.