Commit Graph

554 Commits

Author SHA1 Message Date
Priscilla 6badac5d33 docs: Add v shortcut to the lightbox article. 2018-02-09 18:02:24 -08:00
Rhea Parekh 721a241901 slack importer: Update doc about slack user's skype and phone data. 2018-02-09 12:17:10 -08:00
Rhea Parekh 699021e7d8 slack importer: Update Documentation with slack's legacy token method. 2018-02-09 12:17:10 -08:00
Eeshan Garg 929724e5e7 api docs: Add page for common error payloads.
We now have a separate page for common error payloads, for example,
the payload for when the client's API key is invalid. All error
payloads that are presented on this page will be tested similarly
to our other non-error sample fixtures.
2018-02-08 17:58:41 -08:00
Eeshan Garg ab700fb662 markdown: Add a macro with instructions for creating a bot. 2018-02-08 16:22:55 -08:00
Roman Godov b875fe07eb settings: Added setting to turn on and off realm name in email subject.
Users having only account in one realm will not be distracted by realm
name in subject lines of every email.  Users who have multiple
accounts in realms can turn this setting on and receive a
corresponding realm name in email's subject.

Tweaked by tabbott to rebase and address a few small issues.

Fixes #5489.
2018-02-05 18:01:54 -08:00
Tim Abbott 64cb05be67 import: Update the documentation slightly. 2018-02-05 14:53:07 -08:00
Rhea Parekh 78e0a2613f slack importer: Add documentation for Zulip default stream. 2018-02-05 14:46:39 -08:00
Balaji2198 f49d9d016f hotkeys: Add '>' as a hotkey for quote and reply to message.
Tweaked by tabbott to fix a few minor issues.

Fixes #8146.
2018-02-02 17:37:53 -08:00
Eeshan Garg d46753c26d markdown: Remove macro for successful API JSON response.
Now that we have a Markdown extension-based test framework for
generating and testing code examples on our /api pages, we don't
need this macro anymore!
2018-01-31 07:30:54 -05:00
Jerry Zhang 15ac79cb51 user docs: Add user guide for enabling night mode.
Advertisement for the feature tweaked by tabbott.

Fixes #7405.
2018-01-24 15:16:28 -08:00
rht 6b4f392ee9 Slack importer: Make it transparent to user which parts aren't mapped 1-to-1. 2018-01-23 10:36:14 -05:00
Cynthia Lin d449fcb309 user docs: Dynamically replace keyboard shortcuts for Mac OS. 2018-01-22 19:41:17 -05:00
Brock Whittaker 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
Robert Hönig 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
Rhea Parekh dd51f348e5 Slack importer: Update documentation. 2018-01-08 08:05:50 -05:00
Jerry Zhang 535e6bd218 user docs: Add user guide for configure authentication methods.
Fixes #3357.
2017-12-31 08:09:47 -05:00
Cynthia Lin c31e148ea8 user docs: Add links back to homepage to the bottom of the sidebars. 2017-12-31 08:08:25 -05:00
Eeshan Garg 229cdfce90 markdown: Add a macro for invalid API key JSON response.
The JSON response for when an invalid API key is used to initiate
an API call seems to be identical in every case, so this macro
can be reused all the time.
2017-12-29 17:03:36 -05:00
Eeshan Garg 3a90a6be5e markdown: Add macro for successful send message JSON response.
The JSON response for when an API call to send a message is
successful is the same for both private and stream messages, so
these macros may be used again.
2017-12-29 17:03:36 -05:00
Rhea Parekh 01fa8416b1 Slack importer: Updating the documentation to the new method.
The already existing import-users-and-channels-from-slack.md file is
updated here to follow the new method.
2017-12-27 07:50:53 -05:00
civilnewsnetwork 0ce8b69fd6 Renamed 'Register' to 'Sign up' including translations 2017-12-18 10:02:15 -05:00
Rishi Gupta b8976ae4bd integrations: Improve wording in create-bot-construct-url.md. 2017-12-11 15:39:26 -06:00
Rishi Gupta f323d59ec0 org settings: Remove double negative from open realm setting.
The current wording is tricky to wrap one's head around.
2017-12-10 23:15:00 -08:00
AlloulDorian 39dc41f40b user docs: Add doc for video calls. 2017-12-07 16:57:50 -08:00
Cynthia Lin b7fb86b9ea user docs: Modify sidebar and index page styling. 2017-12-07 14:40:17 -08:00
Rishi Gupta 191f8f1b39 left sidebar: Change Home to All messages.
We made this change because users often unnecessarily click "Home"
first in their use of Zulip, because it seems appealing.  While "All
messages" isn't quite precise (it doesn't include muted streams), it
does describe relatively simply the interleaved view that this
represents.

This commit leaves everything as "home" in the code, and only changes
user-visible strings and docs. Changing the code will be a big project;
there are hundreds of relevant occurrences in variable names, etc.

Further, we'll probably want to convert those various variable names
in different ways.

Tweaked by tabbott to extend the commit message and update a few comments.
2017-11-28 15:42:58 -08:00
Eeshan Garg 880fd5497a markdown: Add indented versions of multi-line Markdown macros.
This is part of our efforts to change our integrations/webhooks
docs to follow the same sort of numbered-list format as our /help
docs. In order to indicate that paragraphs separated by newlines
are part of the same numbered-list point, every paragraph must be
indented 4 spaces.
2017-11-25 17:01:11 -08:00
derAnfaenger 73915a9631 docs: Move integration docs to /api. 2017-11-17 11:58:54 -08:00
derAnfaenger 6a72fcff9c docs: Fix outdated bots guide link. 2017-11-16 13:58:07 -08:00
Tim Abbott 638eb7a8e4 docs: Update links to ReadTheDocs to always use https.
This is better security practice.

We also add a lint rule to enforce this for the future.
2017-11-16 10:59:24 -08:00
Tim Abbott 054952a44a docs: Update links from codebase to point to ReadTheDocs. 2017-11-16 10:53:49 -08:00
Tim Abbott 07c2b205a4 docs: Update absolute links to point to new URLs.
This should get test-documentation and test-help-documentation passing
again after we moved everything around in the last commit.

There are a lot more absolute links (generally in code comments) to
update, but they are lower-priority and can be done in a follow-up
pass.
2017-11-16 10:08:22 -08:00
Brock Whittaker d2e55fa5c8 /api/ & /help/: Change index to <h1>.
The Index should be presented as an <h1> section and to the far left.
2017-11-08 13:01:33 -08:00
Brock Whittaker 228b0c4290 /help/: Add a slide class for sidebars that should have slide mechanism.
This adds a slide class that specifies that the JS actions for sliding
up and down sections is the desired behavior, along with a bit of CSS
to help display correctly in the case of not being a sliding section.
2017-11-08 13:01:33 -08:00
sagar-kalra c2f1f54190 help: Fix indentation of code blocks in desktop install guide.
Apparently, one can fix these by indenting 4 spaces beyond what would
have been sufficient to stay inside the bulleted lists.

Fixes #7075.
2017-11-07 15:48:34 -08:00
Greg Price eb55a3a1ba template context: Give better names to the URLs for the API.
The "subdomain" label is redundant, to the extent it's even
accurate -- this is really just the URL we want to display,
which may or may not involve a subdomain.  Similarly "external".

The former `external_api_path_subdomain` was never a path -- it's a
host, followed by a path, which together form a scheme-relative URL.
I'm not quite convinced that value is actually the right thing in
2 of the 3 places we use it, but fixing that can start by giving an
accurate name to the thing we have.
2017-10-30 18:29:29 -07:00
Greg Price aeb69dfd61 template context: Eliminate now-constant variable `api_site_required`. 2017-10-30 18:29:29 -07:00
Rishi Gupta b7a9068724 mobile: Update docs and portico URLs to point to new Android app. 2017-10-28 15:27:29 -07:00
Tim Abbott d8a873a571 filter: Improve group-pm-with descriptions.
This makes it a bit clearer what this actually does.
2017-10-24 13:19:24 -07:00
Alexis La Porte e7f932aa87 docs: Fix a typo in text of user doc for allow image/link previews.
Fixes #7144
2017-10-24 09:48:45 -07:00
akashnimare 70367deec3 apps: Add a direct link to installation section in desktop guide.
Fixes #6595.
2017-10-18 14:23:47 -07:00
Tim Abbott 8afe9835f6 lint: Ban two spaces after comma in prose. 2017-10-18 10:12:41 -07:00
Rishi Gupta c13d2cb00a user docs: Update create-a-stream to point to the org guide on streams.
Also cleans up the intro a bit.
2017-10-17 22:13:29 -07:00
Tim Abbott 93e666c4bf compose: Restore shift-enter to always inserting a newline.
This was a not-well-thought-through behavior change done in #6489; the
part that was actually a problem was ctrl-enter not producing spaces
anyway.

So we fix this, and also add a comment explaining why.

Fixes #6908.
2017-10-09 15:10:54 -07:00
Eeshan Garg 1153288681 markdown: Add macro linking to our Bots Guide tutorials.
This macro is for when we want to describe how to run a bot on
a running Zulip server in our bots' docs.
2017-10-09 11:40:44 -07:00
Rishi Gupta 71485b14d6 help: Update keyboard-shortcuts.md.
Reorganizes shortcuts and rewords shortcut descriptions. Adds a new "the
basics" section at the top. Does not add or remove any shortcuts.
2017-10-05 23:13:35 -07:00
Rishi Gupta fd0fc77f92 user docs: Use sentence case for titles of sections.
Also changes "Main Index" to "Index", since "Main index" doesn't look great.
2017-10-05 23:12:24 -07:00
Rishi Gupta 0e0eb2d9c8 user docs: Add top level sections to sidebar. 2017-10-05 23:12:24 -07:00
Rishi Gupta eedad34b3c user docs: Add an organization basics section.
This section has the docs a new admin might look at during initial set up.

Does not add or remove articles, just moves stuff around on the
sidebar. Does remove the "Miscellaneous" section.
2017-10-05 23:12:24 -07:00