Commit Graph

1207 Commits

Author SHA1 Message Date
Alex Vandiver 915e5a40d7 docs: Clarify that the Slack app and API token should be removed. 2021-05-27 22:46:02 -07:00
Tim Abbott 66052954e0 apidocs: Fix messages match narrow URL.
The operationId was clearly a better label.
2021-05-26 17:38:00 -07:00
Suyash Vardhan Mathur b41be98c42 apidocs: Fix playground URLs and operationIDs.
We standardized on "Code playground" for this feature, so use that
in the URLs and API documentation.
2021-05-26 17:38:00 -07:00
Allen Cao bdedaba273
help: Remove obsolete reserved names documentation.
Because our mention logic now has a way to distinguish a user with one of these
weird names from a wildcard mention, we no longer need this explicit warning.

(It'd still be a bit confusing, but no more so than various other weird names you could
invest).
2021-05-24 17:44:28 -07:00
slefforge 99097b10fc help: Fix formatting on stream-permissions table legend.
This is a bit hacky, but it avoids the legend being weirdly
misaligned.

Fixes #18062.
2021-05-23 12:04:11 -07:00
m-e-l-u-h-a-n 5b4e823836 help: Mention possibility of re-hiding muted user's revealed message. 2021-05-21 17:23:29 -07:00
rht aa3cdfa2e9 Fix typos using codespell.
The command:
codespell --skip='./locale,*.svg,./docs/translating,postgresql.conf.template.erb,.*fixtures,./yarn.lock,./docs/THIRDPARTY,./tools/setup/emoji/emoji_names.py,./tools/setup/emoji/emoji_map.json,./zerver/management/data/unified_reactions.json' --ignore-words=codespell_ignore_words.txt .

The content of codespell_ignore_words:
```
te
ans
pullrequest
ist
cros
wit
nwe
circularly
ned
ba
ressemble
ser
sur
hel
fpr
alls
nd
ot
```
2021-05-18 17:33:51 -07:00
Tim Abbott 39519fc5c6 help: Use a tip to highlight giphy self-hosting situation. 2021-05-14 16:11:03 -07:00
Tim Abbott 16d39db043 help: Better highlight email gateway configuration is required. 2021-05-14 16:11:03 -07:00
Tim Abbott 0fe785183f help: Document anti-tracking features of images. 2021-05-14 16:11:03 -07:00
Tim Abbott b28389c5e4 help: Document GIPHY privacy story. 2021-05-14 16:11:03 -07:00
Anders Kaseorg e015f3ed7d docs: Correct “webapp” to “web app”.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-05-14 13:15:38 -07:00
Abhijeet Prasad Bodas 9a64f741ec help: Clarify what muting means for the muted user.
We don't want to claim something so strong as the first of this text,
because the mutee can still guess that they have been muted if the
muter suddenly starts completely ignoring messages, especially PMs.

But this framing is better in retaining the perspective as you.
2021-05-14 11:14:48 -07:00
Tim Abbott 0cc3375c41 help: Improve reference to moving topics in moderation guide. 2021-05-13 09:25:54 -07:00
Tim Abbott 97f1dc4e08 help: Document new setting for moving a topic between streams.
I'd like to do more refactoring on this documentation, but at least we
now explain the current model accurately.
2021-05-13 09:02:24 -07:00
Tim Abbott 8946e44200 help: Simplify explanation of muting. 2021-05-12 11:50:56 -07:00
Tim Abbott b5d5ed956a help: Adjust mute-a-user documentation to link related articles. 2021-05-12 11:50:56 -07:00
Abhijeet Prasad Bodas e5a339df25 recent topics: Handle muted user avatars in participants.
We use styling same as that of the number shown for overflow
(e.g "+3") which has a gray background.
To keep these avatars up-to-date, we need to rerender the
recent topics view after receiving a `muted_users` event.

Also update the user documentation to mention this detail.
We deliberately avoid mentioning "recent topics" because
this applies to mobile too.
2021-05-12 09:30:24 -07:00
Abhijeet Prasad Bodas c637994612 help: Fix typo in mute-a-user page.
Also make the sentence more clearer.
2021-05-11 13:21:38 -07:00
Alex Vandiver 9d7fc01622 docs: Clarify wording about muting and admin pages. 2021-05-10 14:39:08 -10:00
Abhijeet Prasad Bodas 67cd385cec mute user: Add user documentation page.
Also link to it from the API documentation page,
other help pages, and the confirmation dialog for
muting a user.

With substantial edits by tabbott and alya.
2021-05-10 17:10:40 -07:00
Siddharth Asthana 6ee7d5c983 docs: Improve documentation for changing a realm's subdomain.
Add a single line for self-hosting case to point to the ReadTheDocs
section of management command to change the realm's subdomain.

Fixes: #17857
2021-05-10 12:33:43 -07:00
Anders Kaseorg 544bbd5398 docs: Fix capitalization mistakes.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-05-10 09:57:26 -07:00
Sumanth V Rao f611e83d33 help: Remove typeahead workaround mentioned in our code-blocks doc.
In 215320bc72, we added the typeahead for
the `pygments_name` field which helped lookup the human-readable
`pretty_name`. However, we forgot to remove the workaround method
mentioned in the docs to lookup the name before the typeahead was
introduced.
2021-05-09 16:13:21 -07:00
Nikhil Maske 88c0f68bd9 docs: Remove the outdated docs related to Group PMs.
As we change the icon for Group PMs in #18160, the docs related
to it is now outdated. This commit removes the documentation part
that is outdated from status-and-availability section.
2021-05-06 11:22:04 -07:00
Alya Abbott 279f7b1c8d user docs: Create separate "Code blocks" user documentation page.
* Move the extended documentation of code blocks to a separate page.
* Merge "code playgrounds" documentation to be a section of that page.
* Document copy widget on code blocks.
* This commit changes how we refer to "```python" type syntax for code
  blocks. Instead of being called a syntax highlighting label, this is
  now referred to as a "language tag", since it serves both syntax
  highlighting and playgrounds.
* Remap all the links.
* Advertise this new page in various places that previously did not have a link.
2021-05-05 16:11:21 -07:00
Nikhil Maske f86ed57255 docs: Fix typos in user docs.
Fixes #18294.
2021-05-05 09:02:30 -07:00
Sumanth V Rao a40fe26586 help: Document playgrounds on /help, /features and /for/open-source.
Linked the Help Center document in places like
    - zulip.yaml (/events, /register/, realm/playgrounds,
                  /realm/playgrounds/{playground_id})
    - /help/format-your-message-using-markdown (Linked to make
      users reading the markdown code block style, aware of this
      feature)
    - /templates/settings/playground_settings_admin.hbs (Linked
      as a reference to read more about playgrounds before
      configuring one)

Also showcase the feature on /features and /for/open-source.
2021-05-04 12:19:01 -07:00
mandepsingh 61de39dd6f help: Improve alignment for markdown tables. 2021-05-01 08:21:03 -07:00
Tim Abbott ee91195457 help: Clarify that moderators are automatically Full Members.
I felt the previous text here was somewhat ambiguous.
2021-05-01 08:09:16 -07:00
sahil839 864fc42e67 help: Update the docs of various settings to use correct subsection.
This commit fixes the following help pages -

- configure-who-can-create-a-stream.md to use "Stream permissions"
  subsection and not "Other permissions".

- configure-who-can-invite-to-streams.md to use "Stream permissions"
  subsection and not "Other permissions".

- restrict-wildcard-mentions.md to use "Stream permissions" subsection
  and not "Organization permissions".

- restrict-bot-creation.md to use "Other permissions" subsection and
  not "Organization permissions".

- restrict-visibility-of-email-addresses.md to use "User identity"
  subsection and not "Organization permissions".
2021-05-01 08:05:50 -07:00
sahil839 2da17814d7 help: Fix invite-new-users.md to show all options of 'who can invite'.
This commit fixes invite-new-users.md to show all the options of who
can invite under "Are invitations required for joining the organization?"
and makes this page similar to help pages for other policies.
2021-05-01 08:05:49 -07:00
sahil839 1a81e05aac help: Fix add-or-remove-users-to-a-stream.md.
This commit fixes add-or-remove-users-to-a-stream.md
to mention that one can configure who can add users
to a stream.
2021-05-01 08:01:33 -07:00
sahil839 d1f34939b9 help: Fix restrict-permissions-of-new-members.md.
This commit updates restrict-permissions-of-new-members.md
to add "inviting users to organization" in the list of actions
that can be restricted for new members.

We also fix the subsection of waiting_period_threshold to be
"Joining the organization".
2021-05-01 07:57:30 -07:00
sahil839 ff6224913a help: Fix restrict-private-messages.md to use correct subsection.
This commit fixes the subsection of private message policy dropdown
to be "Other permissions" and not "Organization Permissions".
2021-05-01 07:56:52 -07:00
sahil839 2f8fc626dd help: Modify help pages of various settings to include moderator.
This commit modifies the create stream, who-can-create-streams,
who-can-invite-to-stream, and change-a-user-role help pages to
include moderator role.
2021-05-01 07:56:52 -07:00
Tim Abbott ade32137eb help: Improve documentation for starred messages.
* Add mobile app instructions for interacting with them.
* Fix inconsistent headings.
* Document the new state that starred message counts are the deafult,
  and mention the "come back to" workflow for them.
2021-05-01 07:33:03 -07:00
aryanshridhar c7ff4228ed user docs: Update change-your-profile-picture section within docs.
Commit dc67870 introduced a user confirmation modal before
deleting profile picture, leaving the user documentation
unchanged.

Added a commit to reflect the newly added change within
the user documentation as well.
2021-04-30 16:10:47 -07:00
sahil839 1944d4e5df help: Update invite-new-users.md to include owners in role choices. 2021-04-30 15:57:09 -07:00
sahil839 e669818544 invites: Allow user to be invited as a moderator.
This commit adds both frontend and backend code to invite a user as
moderator. We allow only existing owners and admins to invite a user
as a moderator.
2021-04-30 15:57:09 -07:00
Nikhil Maske 04da50a7bb user docs: Move "Create a poll" section in Sending messages.
Fixes #18312.
2021-04-30 09:37:48 -07:00
Tim Abbott fd52c1b114 help: Lightly advertise moderator users role. 2021-04-29 15:52:24 -07:00
Tim Abbott a95cb97ceb help: Add basic documentation for organization moderators.
We'll extend this in the future with details on what is configurable,
but this at least ensures we don't have a state where they don't
appear in our documentation at all.
2021-04-29 15:49:02 -07:00
Aman Agrawal 5bd37b44f2 zulip-icon: Add `zulip-icon` as classPrefix for icon.
This avoids general class names like `bot`.
2021-04-29 09:02:25 -07:00
Aman Agrawal f47e93481e giphy: Set rating according to realm_giphy_rating.
We set rating of GIFs retrieved from GIPHY according to
realm_giphy_rating setting. Also, we allow user to set
a rating in organization settings.
2021-04-28 07:07:36 -07:00
Tim Abbott b50e261cac help: Document support for disabling notification sounds. 2021-04-27 16:47:13 -07:00
Anders Kaseorg 6060d0d364 docs: Add missing space to compound verbs “log in”, “set up”, etc.
Noun: backup, checkout, cleanup, login, logout, setup, shutdown, signup,
timeout.

Verb: back up, check out, clean up, log in, log out, set up, shut
down, sign up, time out.

Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-04-26 09:31:08 -07:00
Alex Vandiver ec12a6128a scripts: Add a start-server as well.
In general, `./scripts/restart-server` will already work in any
circumstance where the server is already stopped and needs to be
started.  However, it will output a couple minor warnings, and it is
not readily obvious that it *will* work correctly.

Add an alias for `restart-server` named `start-server`, for
parallelism with `stop-server`, which omits the steps of
`restart-server` which would stop the server first.
2021-04-21 10:24:08 -07:00
Alex Vandiver 476524c0c1 scripts: Add a script to stop the server.
Using `supervisorctl stop all` to stop the server is not terribly
discoverable, and may stop services which are not part of Zulip
proper.

Add an explicit tool which only stops the relevant services.  It also
more carefully controls the order in which services are stopped to
minimize lost requests, and maximally quiesce the server.

Locations which may be stopping _older_ versions of Zulip (without
this script) are left with using `supervisorctl stop all`.

Fixes #14959.
2021-04-21 10:24:08 -07:00
Mateusz Mandera 8d4ab69a46 docs: Move the /configure-missed-message-emails help page.
configure-message-notification-emails is the correct name now.
2021-04-21 10:10:54 -07:00