Commit Graph

528 Commits

Author SHA1 Message Date
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
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