zulip/templates/zerver/api
Rohitt Vashishtha 912e372c4e markdown: Remove !avatar() and !gravatar() syntax.
This particular commit has been a long time coming. For reference,
!avatar(email) was an undocumented syntax that simply rendered an
inline 50px avatar for a user in a message, essentially allowing
you to create a user pill like:

`!avatar(alice@example.com) Alice: hey!`

---

Reimplementation

If we decide to reimplement this or a similar feature in the future,
we could use something like `<avatar:userid>` syntax which is more
in line with creating links in markdown. Even then, it would not be
a good idea to add this instead of supporting inline images directly.

Since any usecases of such a syntax are in automation, we do not need
to make it userfriendly and something like the following is a better
implementation that doesn't need a custom syntax:

`![avatar for Alice](/avatar/1234?s=50) Alice: hey!`

---

History

We initially added this syntax back in 2012 and it was 'deprecated'
from the get go. Here's what the original commit had to say about
the new syntax:

> We'll use this internally for the commit bot.  We might eventually
> disable it for external users.

We eventually did start using this for our github integrations in 2013
but since then, those integrations have been neglected in favor of
our GitHub webhooks which do not use this syntax.

When we copied `!gravatar` to add the `!avatar` syntax, we also noted
that we want to deprecate the `!gravatar` syntax entirely - in 2013!

Since then, we haven't advertised either of these syntaxes anywhere
in our docs, and the only two places where this syntax remains is
our game bots that could easily do without these, and the git commit
integration that we have deprecated anyway.

We do not have any evidence of someone asking about this syntax on
chat.zulip.org when developing an integration and rightfully so- only
the people who work on Zulip (and specifically, markdown) are likely
to stumble upon it and try it out.

This is also the only peice of code due to which we had to look up
emails -> userid mapping in our backend markdown. By removing this,
we entirely remove the backend markdown's dependency on user emails
to render messages.

---

Relevant commits:

- Oct 2012, Initial commit        c31462c278
- Nov 2013, Update commit bot     968c393826
- Nov 2013, Add avatar syntax     761c0a0266
- Sep 2017, Avoid email use       c3032a7fe8
- Apr 2019, Remove from webhook   674fcfcce1
2020-07-07 10:39:44 -07:00
..
add-linkifier.md api docs: Improve headings and organization for endpoints. 2020-06-18 22:38:05 -07:00
add-reaction.md openapi: Make api-docs filename match with operationIds. 2020-06-18 22:38:05 -07:00
api-keys.md api docs: Update api-keys. 2018-09-25 21:02:58 -07:00
changelog.md markdown: Remove !avatar() and !gravatar() syntax. 2020-07-07 10:39:44 -07:00
check-narrow-matches.md api docs: Document GET /messages/matches_narrow endpoint. 2020-06-19 15:28:10 -07:00
client-libraries.md docs: Add top level page for language bindings. 2019-11-22 04:33:18 -08:00
configuring-python-bindings.md api docs: Make minor copyediting changes. 2018-09-25 20:48:12 -07:00
construct-narrow.md docs: Further expand documentation on using IDs in narrows. 2019-09-16 17:17:03 -07:00
create-stream.md api docs: Correct errors in the stream creation documentation. 2020-06-25 14:34:10 -07:00
create-user-group.md api docs: Improve headings and organization for endpoints. 2020-06-18 22:38:05 -07:00
create-user.md openapi: Parse {!api-admin-only.md!} in OpenAPI markdown extension. 2020-06-19 11:04:46 -07:00
deactivate-user.md openapi: Parse {!api-admin-only.md!} in OpenAPI markdown extension. 2020-06-19 11:04:46 -07:00
delete-message.md openapi_docs: Replace `argument` with `parameter`. 2020-06-18 09:18:27 -07:00
delete-queue.md js_examples: Migrate and test delete_queue example. 2020-06-23 14:35:07 -07:00
delete-stream.md api docs: Improve headings and organization for endpoints. 2020-06-18 22:38:05 -07:00
deploying-bots.md api_docs: Change `zulipchat.com` links to relative internal links. 2020-05-29 15:04:50 -07:00
dev-fetch-api-key.md openapi_docs: Replace `argument` with `parameter`. 2020-06-18 09:18:27 -07:00
get-attachments.md openapi_docs: Replace `argument` with `parameter`. 2020-06-18 09:18:27 -07:00
get-custom-emoji.md js_examples: Migrate and test get_custom_emoji example. 2020-06-23 14:35:07 -07:00
get-events.md js_examples: Migrate and test get_events example. 2020-07-01 17:23:30 -07:00
get-linkifiers.md api docs: Improve headings and organization for endpoints. 2020-06-18 22:38:05 -07:00
get-message-history.md openapi_docs: Replace `argument` with `parameter`. 2020-06-18 09:18:27 -07:00
get-messages.md js_examples: Migrate and test get_messages example. 2020-06-23 14:35:07 -07:00
get-own-user.md js_examples: Migrate and test get_own_user example. 2020-06-23 14:35:07 -07:00
get-raw-message.md api docs: Improve headings and organization for endpoints. 2020-06-18 22:38:05 -07:00
get-server-settings.md api docs: Improve headings and organization for endpoints. 2020-06-18 22:38:05 -07:00
get-stream-id.md js_examples: Migrate and test get_stream_id example. 2020-06-23 14:35:07 -07:00
get-stream-topics.md js_examples: Migrate and test get_stream_topics example. 2020-06-23 14:35:07 -07:00
get-streams.md js_examples: Migrate and test get_streams example. 2020-07-01 17:23:30 -07:00
get-subscription-status.md api docs: Improve headings and organization for endpoints. 2020-06-18 22:38:05 -07:00
get-subscriptions.md js_examples: Migrate and test get_subscriptions example. 2020-06-23 14:35:07 -07:00
get-user-groups.md openapi_docs: Replace `argument` with `parameter`. 2020-06-18 09:18:27 -07:00
get-user-presence.md openapi: Make api-docs filename match with operationIds. 2020-06-18 22:38:05 -07:00
get-user.md openapi_docs: Replace `argument` with `parameter`. 2020-06-18 09:18:27 -07:00
get-users.md js_examples: Migrate and test get_users example. 2020-06-23 14:35:07 -07:00
incoming-webhooks-overview.md markdown: Remove !avatar() and !gravatar() syntax. 2020-07-07 10:39:44 -07:00
incoming-webhooks-walkthrough.md docs: Update URLs to use https://zulip.com. 2020-06-08 18:10:45 -07:00
index.md openapi: Make api-docs filename match with operationIds. 2020-06-18 22:38:05 -07:00
installation-instructions.md api docs: Fix link to client libraries. 2019-11-22 11:08:44 -08:00
integrations-overview.md openapi: Make api-docs filename match with operationIds. 2020-06-18 22:38:05 -07:00
mark-all-as-read.md openapi: Make api-docs filename match with operationIds. 2020-06-18 22:38:05 -07:00
missing.md
mute-topic.md openapi: Make api-docs filename match with operationIds. 2020-06-18 22:38:05 -07:00
non-webhook-integrations.md docs: Extract a Writing Documentation top-level section. 2019-05-29 15:52:11 -07:00
outgoing-webhooks.md api_docs: Change `zulipchat.com` links to relative internal links. 2020-05-29 15:04:50 -07:00
reactivate-user.md openapi: Parse {!api-admin-only.md!} in OpenAPI markdown extension. 2020-06-19 11:04:46 -07:00
real-time-events.md openapi: Make api-docs filename match with operationIds. 2020-06-18 22:38:05 -07:00
register-queue.md js_examples: Migrate and test register_queue example. 2020-06-23 14:35:07 -07:00
remove-linkifier.md api docs: Improve headings and organization for endpoints. 2020-06-18 22:38:05 -07:00
remove-reaction.md openapi: Make api-docs filename match with operationIds. 2020-06-18 22:38:05 -07:00
remove-user-group.md openapi: Make api-docs filename match with operationIds. 2020-06-18 22:38:05 -07:00
render-message.md js_examples: Migrate and test render_message example. 2020-06-23 14:35:07 -07:00
rest-error-handling.md openapi_docs: Replace `argument` with `parameter`. 2020-06-18 09:18:27 -07:00
rest.md docs: Add top level page for language bindings. 2019-11-22 04:33:18 -08:00
running-bots.md api: Document using `pip3 install` for zulip_bots(erver). 2019-08-23 15:51:06 -07:00
send-message.md openapi_docs: Replace `argument` with `parameter`. 2020-06-18 09:18:27 -07:00
set-typing-status.md js_examples: Migrate and test set_typing_status example. 2020-06-23 14:35:08 -07:00
sidebar_index.md api docs: Add an API changelog page. 2020-04-28 22:23:25 -07:00
subscribe.md js_examples: Migrate and test add_subscriptions example. 2020-06-23 14:35:08 -07:00
unsubscribe.md js_examples: Migrate and test remove_subscriptions example. 2020-06-23 14:35:08 -07:00
update-message-flags.md js_examples: Migrate and test update_message_flags example. 2020-06-23 14:42:03 -07:00
update-message.md js_examples: Migrate and test update_message example. 2020-06-23 14:42:03 -07:00
update-notification-settings.md openapi_docs: Replace `argument` with `parameter`. 2020-06-18 09:18:27 -07:00
update-stream.md api docs: Improve headings and organization for endpoints. 2020-06-18 22:38:05 -07:00
update-subscription-settings.md api docs: Improve headings and organization for endpoints. 2020-06-18 22:38:05 -07:00
update-user-group.md api docs: Improve headings and organization for endpoints. 2020-06-18 22:38:05 -07:00
update-user.md openapi: Parse {!api-admin-only.md!} in OpenAPI markdown extension. 2020-06-19 11:04:46 -07:00
upload-custom-emoji.md api docs: Improve headings and organization for endpoints. 2020-06-18 22:38:05 -07:00
upload-file.md openapi_docs: Replace `argument` with `parameter`. 2020-06-18 09:18:27 -07:00
writing-bots.md python: Convert more variable type annotations to Python 3.6 style. 2020-05-08 16:42:43 -07:00