3189388258
api docs: Show Python and JavaScript examples first.
...
It makes sense to make our Python and JS API examples more visible
than our curl examples, since Python is what most people will tend
to use.
Also, from a design perspective, an API documentation page that
starts off with a shiny Python example with syntax highlighting
looked much better than having a bland curl example be the first
thing readers see.
2018-01-22 18:10:29 -05:00
96362e8e60
api docs: Move code examples farther up.
2018-01-22 18:10:29 -05:00
668ac28b85
api/sidebar.md: Move "REST API" to the bottom.
2018-01-22 18:10:29 -05:00
41685105db
api/update-message: Make it render correctly in Github.
2018-01-22 15:35:49 -05:00
992b416802
api/delete-queue: Add Python syntax highlighting.
2018-01-22 15:35:49 -05:00
b71ed33e64
compose: Extract the 'Sending...' from template to be added with Js.
...
In this we change the way 'Sending...' is displayed. Instead of
hardcoding it into the template we make change the paradigm so
that we can have a flexible message about what's happening
rather than just always saying 'Sending...'. For eg. this will
help in the upcoming feature of Scheduled Messages by having this
message say 'Scheduling...'.
2018-01-19 11:33:11 -05:00
6b03e25382
help: Add "Add a link preview" documentation.
...
This is a server setting so I created the section "Server settings" in the help sidebar for this to go under, and rewrote the copy and retook the images that were originally done by @Privisus due to some issues.
2018-01-19 06:15:30 -05:00
a5e55cee9b
bot docs: Clean up "Testing a bot's output".
...
The main cleanup here is to move the examples out of the bulleted
list, which was getting rendered in an ugly/confusing way.
I also removed some redundant text, fixed some typos, and changed
the wording a bit.
2018-01-18 16:09:24 -05:00
0bca0286a1
billing: Integrate Stripe, using Stripe Checkout.
...
Stripe Checkout means using JS code provided by Stripe to handle
almost all of the UI, which is great for us.
There are more features we should add to this page and changes we
should make, but this gives us an MVP.
[greg: expanded commit message; fixed import ordering and some types.]
2018-01-17 16:43:54 -08:00
a0526206f9
api/delete-queue: Add JavaScript example.
2018-01-17 09:27:35 -05:00
af1290fde7
api/get-events-from-queue: Recommend using zuliprc.
...
Recommend using a zuliprc file instead of hardcoding the API
credentials in a config object.
2018-01-17 09:27:35 -05:00
8ed0a0950e
api/register-queue: Recommend using zuliprc.
...
Recommend using a zuliprc file instead of hardcoding the API
credentials in a config object.
2018-01-17 09:27:35 -05:00
df00e6a45f
api/create-user: Add JavaScript example.
2018-01-17 09:27:35 -05:00
0e778e152d
api/get-profile: Add JavaScript example.
2018-01-17 09:27:35 -05:00
dd88cfac16
api/get-all-users: Recommend using zuliprc.
...
Recommend using a zuliprc file instead of hardcoding the API
credentials in a config object.
2018-01-17 09:27:35 -05:00
e18b9ae1c1
api/remove-subscriptions: Add JavaScript example.
2018-01-17 09:27:35 -05:00
6d92c88997
api/add-subscriptions: Add JavaScript example.
2018-01-17 09:27:35 -05:00
4d8c20b773
api/get-subscribed-streams: Recommend using zuliprc.
...
Recommend using a zuliprc file instead of hardcoding the API
credentials in a config object.
2018-01-17 09:27:35 -05:00
b32bb7d5f4
api/get-stream-id: Add JavaScript example.
2018-01-17 09:27:35 -05:00
370d2c6bab
api/get-all-streams: Recommend using zuliprc.
...
Recommend using a zuliprc file instead of hardcoding the API
credentials in a config object.
2018-01-17 09:27:35 -05:00
e781a57ca2
api/private-message: Recommend using zuliprc.
...
Recommend using a zuliprc file instead of hardcoding the API
credentials in a config object.
2018-01-17 09:27:35 -05:00
e36d61f216
api/update-message: Add JavaScript example.
2018-01-17 09:27:35 -05:00
ba98451928
api/stream-message: Recommend using zuliprc.
...
Recommend using a zuliprc file instead of hardcoding the API
credentials in a config object.
2018-01-17 09:27:35 -05:00
360885fb12
api/render-message: Add JavaScript example.
2018-01-17 09:27:35 -05:00
cc8942e0dc
/team: Fetch zulip-js repository data.
2018-01-16 12:23:19 -05:00
93f47fa700
outgoing webhooks: Rename "Base URL" to "Endpoint URL".
...
Based on user feedback. "Endpoint URL" gives a clearer
idea of the field's purpose.
2018-01-16 08:11:51 -05:00
a14b52ef1d
api docs: Document the `DELETE /users/me/subscriptions` endpoint.
...
Note that there is currently no JavaScript method in zulip-js
to call this endpoint.
2018-01-12 07:30:38 -05:00
1b3b907694
delete-queue.md: Specify queue_id as a required argument.
...
Specifying it as an optional one was a mistake.
2018-01-12 07:30:38 -05:00
8c723e8c27
api docs: Document the POST /api/v1/users endpoint.
...
Note that there is no JavaScript equivalent for requesting this
endpoint in zulip-js yet.
2018-01-12 07:30:38 -05:00
763a96228f
left sidebar: Remove plus icon from the stream bar.
2018-01-09 09:05:23 -05:00
dd51f348e5
Slack importer: Update documentation.
2018-01-08 08:05:50 -05:00
a01f8c088a
api docs: Document the POST /api/v1/users/me/subscriptions endpoint.
...
There is a JavaScript equivalent for this endpoint but the npm
package has not yet been released.
2018-01-07 15:19:51 -05:00
ae59b08316
api docs: Document the GET /api/v1/users/me endpoint.
...
Note that there is no JavaScript equivalent for requesting this
endpoint in zulip-js yet.
2018-01-07 15:19:51 -05:00
045aacbc67
api docs: Document the PATCH /api/v1/messages/<msg_id> endpoint.
...
Note that there is no JavaScript equivalent for requesting this
endpoint in zulip-js yet.
2018-01-07 15:19:51 -05:00
6f01b042a1
api docs: Document the DELETE /api/v1/events endpoint.
...
Note that there is no JavaScript equivalent for requesting this
endpoint in zulip-js yet.
2018-01-07 15:19:51 -05:00
da06832837
right-sidebar: Make Search people input collapsible with search icon.
...
Fixes #4816
2018-01-07 15:05:03 -05:00
7c1a803927
left-sidebar: Fix styling of Streams header to not use links.
2018-01-07 15:05:03 -05:00
7790e2b23c
org settings: Add framework for User groups page.
2018-01-06 11:50:52 -05:00
479bc41ca5
api docs: Remove old and outdated endpoint docs.
2018-01-04 10:17:29 -05:00
1fd71287d6
api docs: Document the GET /api/v1/events endpoint.
2018-01-04 10:17:29 -05:00
d235a6c0c4
api docs: Remove superfluous sys imports in Python examples.
...
These are remnants from old code examples that I forgot to
remove.
2018-01-04 10:17:29 -05:00
c616d7869b
api docs: Recommend using zuliprc file for configuration.
...
In our code examples, we now recommend using a zuliprc file
instead of passing in the config info directly.
2018-01-04 10:17:29 -05:00
f620525373
api docs: Document the POST /api/v1/register endpoint.
2018-01-03 12:23:30 -05:00
535e6bd218
user docs: Add user guide for configure authentication methods.
...
Fixes #3357 .
2017-12-31 08:09:47 -05:00
c31e148ea8
user docs: Add links back to homepage to the bottom of the sidebars.
2017-12-31 08:08:25 -05:00
b73c60a135
api docs: Document the GET /api/v1/users endpoint.
2017-12-30 11:03:23 -05:00
b31bdf23ca
api docs: Document the POST /api/v1/messages/render endpoint.
...
Note that currently, there is no way to interface with this
endpoint using zulip-js.
2017-12-30 11:03:23 -05:00
0458faf2f9
api docs: Document the GET /users/me/subscriptions endpoint.
2017-12-30 11:03:23 -05:00
cf8a8c8811
api docs: Document the GET /api/v1/get_stream_id endpoint.
...
This commit documents the /api/v1/get_stream_id endpoint.
Note that there is currently no way to interface with this
endpoint with zulip-js.
2017-12-30 11:03:23 -05:00
e769a7eed2
api docs: Document the get-streams endpoint.
...
This commit documents the get-streams endpoint, which can be
by making a GET request to /api/v1/streams.
Note that in the code examples, JavaScript is missing an example
for how to pass in the `include_` query parameters. That is
because zulip-js's client.streams.retrieve function doesn't take
any arguments and zulip-js does not export any function equivalent
to client.call_endpoint in python-zulip-api/zulip.
2017-12-29 17:03:36 -05:00
Eeshan Garg
Balaji2198
Aditya Bansal
Brock Whittaker
Steve Howell
Vishnu Ks
Rohitt Vashishtha
Robert Hönig
rht
Rhea Parekh
Cynthia Lin
Jerry Zhang