Commit Graph

572 Commits

Author SHA1 Message Date
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
Rishi Gupta 0474402c51 user docs: Organize message sending and reading docs.
Collects all relevant docs into "Sending Messages" and "Reading Messages".

Doesn't add or remove any docs, just moves them around on the sidebar.
Duplicates "Message a stream by email" (it now appears in two sections)
Removes the "Editing Messages" section/header.
2017-10-05 23:12:24 -07:00
Rishi Gupta 6cccb70922 user docs: Reorganize account basics section.
This section should be the stuff we want users to see when they are first
setting up their account.

This commit only moves links on the sidebar around, no additions or
deletions.
2017-10-05 23:12:24 -07:00
Rishi Gupta 074826485f user docs: Update wordings on left sidebar. 2017-10-05 23:12:24 -07:00
Brock Whittaker c9514d0ad2 /help/: Remove underline and changes text from "Index" => "Main Index".
This removes the underline on hover and changes the text to get to the
index.

This also changes it to an <h2> tag so that it will be more inline
with the styling of the rest of the sections, but without the
down chevron.
2017-10-03 16:36:37 -07:00
Tim Abbott 14b7add4c4 help: Reorganize the sections somewhat. 2017-10-03 11:19:07 -07:00
Cynthia Lin ea75772a01 user docs: Add index page for searching. 2017-10-03 11:13:36 -07:00
Cynthia Lin 71af43601a user docs: Add collapsible sidebar sections. 2017-10-03 11:13:36 -07:00
Greg Price 5b8eac3895 help: Revise the desktop install help for clarity.
This deserves a fact-check to make sure I haven't simplified
anything past what's true!  Note in particular the TODO comments.

Especially in particular, I took out references to the .zip installer
for macOS and the .deb installer for Linux.  I couldn't tell in what
situation we'd really want to steer a user toward them (and wouldn't
recommend instead either the .dmg installer, or the apt or AppImage
instructions, respectively), so taking them out simplifies the
instructions and avoids presenting the user with a choice they have no
context for making.  But if there is such a situation, then we can put
them back.
2017-09-27 19:31:08 -07:00
akashnimare 7d1759818b docs: Add desktop app installation instructions. 2017-09-27 15:50:09 -07:00
Joshua Pan 178f5080cf hotkey.js: Switch 'q' and 'w' hotkeys.
On a standard keyboard, 'q' is to the left of 'w', so it makes sense
for the hotkeys for the left and right sidebars to be `q` and `w`,
respectively, not the other way around.
2017-09-25 12:14:07 -07:00
Abhijeet Kaur 2bf3324395 frontend: Add ability to search by "group-pm-with" search operator.
This allows user to view all group private conversation messages
with a specific user. That is, it views all the the group private
messages from groups which include the given user.

Add search suggestion for group-pm-with. Add operator name
and description in "Search operators" tab.

Add change in tab name to "Group Messages" when using this operator.
Add frontend_tests for group-pm-with search operator.

Fixes: #3882.
2017-09-24 11:58:48 -04:00
Cynthia Lin 6d20557b61 user docs: Update docs referencing Organization permissions page. 2017-09-16 02:26:47 -07:00
Cynthia Lin a758c2615e user docs: Update docs to point to Organization settings page. 2017-09-16 02:26:47 -07:00
Cynthia Lin b721ada944 user docs: Update docs to point to Organization profile page. 2017-09-16 02:26:47 -07:00
Brock Whittaker c8641d49b5 /help/: Remove portico footer.
I don't think we need the footer in here.
2017-08-28 11:07:03 -07:00
rht 437b2a3146 Update "MacOS" text to "macOS" 2017-08-26 09:00:42 -07:00
Brock Whittaker 44636051e4 Make /help/ sidebar more discoverable on mobile/narrow.
This makes the /help/ sidebar more discoverable at windows less
than 1000px in width because it makes it stick out a bit when it
is closed with the hamburger menu at the top.

Fixes: #6038.
2017-08-24 13:38:22 -07:00
Rishi Gupta d28337869e help: Fix links to integrations in organization getting started guide. 2017-08-22 14:26:17 -07:00
Rishi Gupta 4fc263d947 help: Update streams advice in getting-your-organization-started-with-zulip. 2017-08-22 14:26:17 -07:00
Robert Hönig 84a7350de6 docs: Clarify webhook-specific guides. 2017-08-22 10:38:48 -07:00
Vaida Plankyte eb001e42d0 help: Document display emoji reactions as text feature. 2017-08-02 10:13:32 -04:00
rht a2edbcbe94 Do s/ top-right / top right /g. 2017-08-01 15:30:37 -07:00
rht 89afd0da22 Standardize the description of icon-vector-cog at navbar.
While humans can disambiguate 'upper right' and 'top right' to one area,
it might help with any machine reading comprehension task by choosing a
more regular wording.
2017-08-01 15:30:37 -07:00
Rishi Gupta 5aa626e73e help: Link to guides from index.html. 2017-07-31 21:47:33 -07:00
Rishi Gupta 2a69298a1b help: Add Getting started with Zulip. 2017-07-31 21:47:33 -07:00
Rishi Gupta 83fa4708aa help: Move Guides section to top of file. 2017-07-31 21:47:33 -07:00
Rishi Gupta ffe717342e help: Rename Administration to Guides. 2017-07-31 21:47:33 -07:00
Tim Abbott 41f37d0a6f jinja2: Use function interface for render_markdown_path.
Apparently, the filters implementation was doing some sort of strange
caching, where you would need to restart the server in order to
refresh for changes to the markdown content.

We fix this by switching to just calling the render_markdown_path
function from Jinja2.

Fixes #5974.
2017-07-31 14:54:54 -07:00
Vaida Plankyte b8b0cd41d0 help: Add explanation of pointer/unread count behavior.
Fixes #5770.
2017-07-27 18:07:58 -07:00
Vaida Plankyte 636f1d5523 help: Document @all mentions. 2017-07-26 12:09:11 -04:00
Cynthia Lin 89abe5d398 user docs: Document Analytics feature.
Fixes #3648.
2017-07-25 11:18:44 -07:00
Rishi Gupta ad47d3b651 settings: Update wording in organization-permissions-admin.handlebars. 2017-07-24 17:33:14 -07:00
Rishi Gupta 481c85fb48 settings: Update text in templates. 2017-07-24 17:33:14 -07:00
Vaida Plankyte edc341abe7 help: Add documentation on deleting a message.
Fixes #5393.
2017-07-18 16:04:02 -07:00
Vaida Plankyte 358a35f4cb help: Rename Manage organization snippets. 2017-07-17 11:52:15 -07:00
Tim Abbott 40cc6a3fa1 docs: Document disabling message edit history. 2017-07-16 10:13:26 -07:00
Vaida Plankyte 28ea174ed9 backend: Implement high contrast mode display setting. 2017-07-14 14:53:24 -07:00
Brock Whittaker 1cf7ee966b help: Redesign /help/ pages to be a single page app.
This redesigns the /help/ page sets to be a single page app that uses
history.pushState to work the same as the old app.

The big new feature is that now we have the index in a nicely designed
left sidebar.
2017-07-13 15:43:44 -07:00
James Rowan 05934fd4c6 user docs: Clarify that drafts are only stored locally. 2017-07-13 11:21:44 -07:00
Eeshan Garg b37ace33ee help: Document bot types in add-a-bot-or-integration. 2017-07-11 13:25:51 -04:00
Eeshan Garg 37fbed0993 webhooks: Recommend creating "incoming webhook" bot.
In all our webhooks' docs, we now recommend creating a bot with the
"Incoming webhook" bot type.
2017-07-11 13:25:51 -04:00
Vaida Plankyte 1e04ab8b54 help: Add docs on new manage organization features. 2017-07-11 12:35:50 -04:00
Vaida Plankyte 7d98e569c5 help: Add docs for new organization permission settings. 2017-07-10 11:50:40 -07:00
Vaida Plankyte 90877c2100 help: Update links to point to organization permissions. 2017-07-10 11:50:40 -07:00
Tim Abbott 5ee9599acd help: Link to zulipchat.com/apps to have the latest apps page.
Ideally, we'd be using {{ apps_page_url }}, but the /help/ markdown
system doesn't support custom Jinja2 content in its code.
2017-07-07 16:58:04 -07:00
Rishi Gupta e84e6aa818 create_realm: Make placeholder text more generic.
Fixes #2058.
2017-07-06 23:13:29 -04:00
Cynthia Lin 0fc93278ca user docs: Add guide on *Require topics in messages to streams* setting.
Edited by tabbott to simplify the language and explain the purpose of
the setting a bit more.

Fixes #5675.
2017-07-05 11:51:54 -07:00
Eeshan Garg 085ce20feb markdown: Recommend installing bindings to the server with bot.
Instead of recommending our users to download and install our
bindings "to the <integration_name> server", we now recommend
installing our bindings "to the server where the
<integration_name> bot lives". Technically, the latter is more
accurate.
2017-06-26 12:30:04 -04:00
Eeshan Garg 1d9ab996c7 markdown: Clarify stream name recommendations in create-stream.
Now, we further clarify in the create-stream.md macro that even
if users follow our default stream name recommendation for a
given integration, said stream must still be explicitly created.
2017-06-26 12:30:04 -04:00
Eeshan Garg 242162f9db markdown: Add macros for changing integration config files. 2017-06-26 12:30:04 -04:00
James Rowan 7ccdc319c7 help: Fix typos in the guide for new organizations. 2017-06-25 11:20:03 -04:00
Cynthia Lin 27e1393610 docs: Update keyboard shortcuts documentation. 2017-06-21 15:54:09 -04:00
Cynthia Lin 96dc204841 hotkeys: Document `u` hotkey. 2017-06-21 10:38:05 -04:00
Rishi Gupta ca3b9f3059 user docs: Clean up intro text. 2017-06-20 21:25:56 -04:00
Vaida Plankyte b7ea876056 docs: Document ability for admins to delete messages. 2017-06-20 21:17:53 -04:00
vaibhav d9bc3932ec settings: Move "download personal API key" from "your-bots" to "your account"
Fixes: #5355.
2017-06-20 15:46:23 -04:00
Cory Lynch 472e788ee0 Add user documentation for is:unread. 2017-06-19 06:51:13 -04:00
Nick Sweeting 458fcfa646 docs: Add blurb to docs about topic lifetime.
Edited by tabbott to also address the issue of deleting topics.
2017-06-14 19:21:54 -07:00
Eeshan Garg 0d817f0870 markdown: Add macro for appending stream name to integration URL. 2017-06-14 17:42:17 -07:00
Eeshan Garg aa25348ddc markdown: Recommend substituting bot email and API key in URL.
We now recommend substituting the appropriate bot email and
API key in the webhook URL in the webhook-url-with-bot-email.md
macro.
2017-06-14 17:42:14 -07:00
Eeshan Garg 8efb3aeee7 templates: Update .md macros to use recommended_stream_name.
Previously, we used Integration.name as the recommended stream
in our macros. Now, we have a dedicated attribute set in the
Integration class (that WebhookIntegration and GithubIntegration
inherit from) for the recommended stream name in cases where
the stream name is different than the name of the integration
itself.
2017-06-13 15:30:35 -07:00
Aditya Bansal 9219298774 Clean main.html to use 4 space indentation. 2017-06-06 22:04:55 -07:00
Aditya Bansal 7f15cfea91 integrations: Add download python bindings macro.
This will be used in various integration docs.
2017-06-06 21:40:27 -07:00
rht 486e4e30da Update 'OS X' reference to macOS. 2017-06-05 22:11:34 -07:00
Eeshan Garg 3c47efb1fc templates: Add macro for appending branches to webhook URLs.
This macro is an alternative to git-webhook-url-with-branches.md,
which contains the full URL with a `branches` query parameter at
the end. This macro is for when we just want to specify that this
can be done but the URL to append to can be variable or is unique
to a particular integration (and thus, doesn't warrant its own
macro and a full URL example).
2017-06-05 11:22:06 -07:00
Eeshan Garg 433686457a templates: Add Markdown macro for URLs with bot_email@api_key. 2017-06-05 11:22:06 -07:00
Eeshan Garg fab20ec6fd templates: Add macro for appending branch names to Git webhook URLs. 2017-06-05 11:20:48 -07:00
Eeshan Garg af88695c28 templates: Add macro for appending the topic to the webhook URL. 2017-06-01 22:16:10 -07:00
Tim Abbott 4acc89d379 help: Document the : hotkey for choosing reactions. 2017-05-29 15:43:55 -07:00
Tim Abbott 7b152bf0ad help: Clarify discussion of the emoji reactions picker.
The word "menu" was kinda confusing here.

Follow-up to #4547.
2017-05-29 15:43:44 -07:00
Daniel Lau 3037be9bc0 help: Document how to navigate the emoji reactions picker.
Fixes #4547.
2017-05-29 15:43:07 -07:00
Eeshan Garg dd5ce955bd webhooks/delighted: Migrate docs to Markdown. 2017-05-28 18:44:00 -07:00
Eeshan Garg 14ce3a94db webhooks/codeship: Migrate docs to Markdown. 2017-05-28 18:44:00 -07:00
Eeshan Garg 3cb758d339 templates: Support parametric Markdown macros for webhooks docs. 2017-05-24 17:00:19 -07:00
Cynthia Lin 344f284431 user docs: Document Streams menu hotkeys.
Also includes refactoring to **Keyboard shortcuts** user docs.
2017-05-24 12:19:15 -07:00
Cynthia Lin e4543a98ff user docs: Update Streams modal UI screenshots. 2017-05-22 18:35:22 -07:00
Cynthia Lin 6b9dfcec4e user docs: Delete *View information about a message* doc.
Deprecated feature; replaced by message sender info.
2017-05-22 18:35:22 -07:00
Cynthia Lin 561cb64f33 user docs: Update docs with compose box UI changes. 2017-05-22 18:35:22 -07:00
Cynthia Lin f0c5b68a5e user docs: Delete *Restore the last unsent message* doc.
Deprecated feature; Drafts feature has replaced it.
2017-05-22 18:35:22 -07:00
Cynthia Lin 314a506890 user docs: Update *The Zulip browser window* doc. 2017-05-22 18:35:22 -07:00
Cynthia Lin 226e30d9ea user docs: Update *Add custom emoji* doc. 2017-05-22 18:35:22 -07:00
Cynthia Lin bfcb0552e8 user docs: Merge *The announce stream* and *Make an announcement* docs. 2017-05-22 18:35:22 -07:00