Commit Graph

3375 Commits

Author SHA1 Message Date
Tim Abbott
bd08c0b980 docs: Explain web app translations before server, and use those terms.
This seems good for prioritizing what is important first, and should
make it easier to add the Flutter app in the future.
2025-01-31 14:32:47 -08:00
Alya Abbott
e0cf9d33b8 contributor docs: Reorganize internationalization documentation.
Pull forward content that's actionable for contributors, and
organize it in terms of how it will be applied.
2025-01-31 14:32:47 -08:00
Mateusz Mandera
6d555b01d0 docs: Document the push notifications registration transfer flow. 2025-01-30 14:32:36 -08:00
Niloth P
68019cb48d integration-docs: Remove unused macros.
The `append-channel-name` and `append-topic` macros' instructions are
unnecessary as the topic and channel names are now part of the generated
URL.

The `git-webhook-url-branches` macro becomes equivalent to
`git-append-branches` with the auto-generation of the URL.
2025-01-30 11:59:38 -08:00
Alya Abbott
3dd3de3efa contributor docs: Describe how to handle follow-ups. 2025-01-24 15:02:18 -08:00
Steve Howell
aaa8279cb8 testing doc: Update common setup methods.
The names of helpers have evolved over time.

I add a few, and I remove `common_subscribe_to_streams`,
since most tests just want the simpler subscribe.

Note that `subscribe`, while not full stack, does
excercise `bulk_add_subscriptions`. So there is no
real danger of having unrealistic test data.

Almost all of our uses of `common_subscribe_to_streams`
are in test_subs.py, so it's already effectively
our policy to use subscribe in most cases. And
test_subs does more than a thorough job of actually
exercising the API.
2025-01-23 16:10:37 -08:00
Greg Price
9883e41436 docs: Clarify design-discussions as to #mobile-design vs. #design.
We have an increasing number of design discussions about mobile
these days (which is great), and that means I've started to
regularly point people to this page -- particularly the section
"Guidelines for code contributors" -- as part of pointing them to
the #mobile-design channel to ask a design question.

In that context it seems confusing that it only talks about #design
and not #mobile-design.  We do mention the latter elsewhere on the
page, but I still feel I have to explain the discrepancy when
pointing to this section.  Fix it here instead.

This introduces to our docs the concept of "a design channel",
meaning #design and #mobile-design and sometimes #zulip-terminal.
2025-01-22 16:16:33 -08:00
Greg Price
fa06616f71 docs: Pull out named links for channels in design-discussions page.
This helps keep the source a bit more readable; and we'll shortly
add another pair of occurrences of these.
2025-01-22 16:16:19 -08:00
Tim Abbott
84be984619 docs: Add documentation on using icons. 2025-01-22 12:54:19 -08:00
Alya Abbott
d4426f3bab contributor docs: Document how to add and modify icons. 2025-01-22 12:54:19 -08:00
Alex Vandiver
3ec896ebda nginx: Add an option which defaults loadbalancer requests to https.
In some cases, it is not possible to configure the load-balancer to
add an X-Forwarded-Proto header.  If Zulip is serving its traffic over
HTTP, it will rightly error out, since it cannot guarantee that its
response will be served over an encrypted connection.

Add a new `loadbalancer.rejects_http_requests` settings which serves
as a way for the operator to swear that the load-balancer will *never*
serve responses from Zulip over an unencrypted connection.  In most
cases, this is because the load-balancer is configured to have port 80
always serve an HTTP 301 redirect to the same URL over HTTPS.

Properly configuring the proxy to send `X-Forwarded-Proto` is always a
better solution than using this configuration parameter, so use of
this should be viewed as a last resort.
2025-01-22 12:25:42 -08:00
Alex Vandiver
d74e176cbe docs: Fix missing references. 2025-01-21 15:12:49 -08:00
Alex Vandiver
1e9099737d docs: Update changelog for 9.4 release. 2025-01-16 18:00:30 +00:00
Nehal Sharma
04f06a4588 integrations: Add support for BigBlueButton voice only calls.
We now allow users to create voice calls when their call provider is
BigBlueButton. This is done by creating a call where cameras are
disabled for all participants in the call -- a voice call, and making
only the call creator the moderator, so no one else can switch a voice
only call to a video call.

Also, we stop using the deprecated fields "attendeePW" and "moderatorPW"
in the Big Blue Button API, and use "role" instead.

The side effects are that now we only support BigBlueButton 2.4 and
above, and that only the call creator is a moderator and all other
joinees are viewers for all BigBlueButton calls.

Fixes: #26550.

Most of the code for the integration was written by Nehal.
Apoorva made the changes that resolve conflicts which were
introduced because of the `typed_endpoint` decorator.

With some documentation tweaks by tabbott.

Co-authored-by: Apoorva Pendse <apoorvavpendse@gmail.com>
2025-01-09 13:54:46 -08:00
Alya Abbott
34b7c6de2d help: Refresh email notifications help page.
Document more clearly when notifications are triggered.
2025-01-09 12:38:46 -08:00
Lauryn Menard
e882b95d2b help: Adjust links and text for "/help/channels-permissions".
Adjusts links and text to the help center article for revision
of channel permissions documentation, specifically in /docs,
/web, and /zerver directories.

The links in the /help and /templates/corporate directories
were updated when the documentation was revised.
2025-01-07 13:41:40 -08:00
Shubham Padia
333b3904b5 user_group_settings: Use user-group-x icon for deactivate button. 2025-01-06 09:48:28 -08:00
apoorvapendse
892afcbe98 setup_docs: Add command to terminate WSL2 environment.
This commit adds an alternative way to shutdown the
zulip WSL2 environment.
2025-01-04 17:29:27 -08:00
Greg Price
6c80d80ad3 docs: Update contributing/design-discussions for #mobile-design. 2025-01-02 15:48:57 -08:00
apoorvapendse
44f5f4e129 setup_docs: Update vagrant installation to support Ubuntu 24.04.
Update the Vagrant installation procedure, as Vagrant is no
longer available in the apt repository starting from Ubuntu 24.04

Fixes #32837.
2025-01-02 09:13:24 -08:00
Saubhagya Patel
faa9680fc8 docs: Update markdown.md for echo.ts module update.
This commit updates the "Markdown implementation"
documentation in the `markdown.md` file to reflect the
conversion of the `echo.js` module to TypeScript.
2024-12-30 09:43:29 -08:00
Saubhagya Patel
222c59507c docs: Update sending-messages.md for variable/function updates.
This commit updates the "Sending messages" documentation
in the `sending-messages.md` file to reflect the variable and
function updates, ensuring consistency with changes in the
codebase over time.
2024-12-30 09:43:29 -08:00
Anders Kaseorg
58822372d5 typos: Fix typos caught by typos and mwic.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2024-12-24 19:15:36 -08:00
Alex Vandiver
3eb501fa18 requirements: Require some swap space if installed on < 5GB RAM. 2024-12-22 06:52:06 -08:00
apoorvapendse
852fc42317 setup_docs: Fix wording for WSL2 python environment.
This is valid because the WSL2 python environment
has to be always activated manually.
2024-12-18 08:56:27 -08:00
apoorvapendse
d37f6c56be setup_docs: Put activation command in a code block for WSL.
This commit puts the activation command in a code block
instead of an inline code snippet.
2024-12-18 08:56:27 -08:00
Mateusz Mandera
94cc413016 docs: Renaming AzureAD to Entra ID, part two.
This is a follow-up to #32693, which missed a bunch of places due to
varying ways of typing Azure AD. (Azure AD, Azure Active Directory etc.)

In the diff there's an apparent inconsistency with renaming, in some
places renaming to just "Microsoft Entra ID" and in others
"Microsoft Entra ID (AzureAD)".
The idea is to add (AzureAD) in ordinary documentation, as it can help
clarity since many people still think of this as AzureAD, while sticking
with brevity and cleanliness of just using the official name in
marketing focused material.
2024-12-15 08:22:30 -08:00
Mateusz Mandera
81c2c0b328 docs: Finish renaming AzureAD to Entra ID.
Microsoft has been renaming AzureAD to Entra ID. Though both names still
seem to function, even if unofficially, so this mostly renames to `Entra
ID (AzureAD)` to reference both for clarity.
2024-12-12 17:48:54 -08:00
Anders Kaseorg
666ce4519d hashchange: Convert module to TypeScript. (#32670) 2024-12-11 09:15:18 -08:00
Tim Abbott
c39cb05bf4 docs: Rewrite other Linux requirements text.
This is a bit clearer and more appropriate for the heading-based setup
of this page.
2024-12-06 14:37:48 -08:00
Karl Stolley
0200753978 dev_docs: Establish Other Linux tab. 2024-12-06 14:37:48 -08:00
Prakhar Pratyush
3bad36ef8c queue: Rename queue_json_publish to queue_json_publish_rollback_unsafe.
This commit renames the 'queue_json_publish' function to
'queue_json_publish_rollback_unsafe' to reflect the fact that it doesn't
wait for the db transaction (within which it gets called, if any)
to commit and sends event irrespective of commit or rollback.

In most of the cases we don't want to send event in the case of
rollbacks, so the caller should be aware that calling the function
directly is rollback unsafe.

Fixes part of #30489.
2024-12-06 09:23:02 -08:00
Emil Grehn
58d91dacd5 message_quoting: Rename 'Quote and reply' to 'Quote message'.
'Quote message' is a more accurate decription, as this option inserts
the quoted text into whatever message you're composing or editing;
it does not necessarily start a new reply.

Fixes first part of #31953.
2024-12-04 22:25:14 -08:00
Anders Kaseorg
0048dfabd0 admin: Convert module to TypeScript.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2024-11-27 16:46:35 -08:00
Tim Abbott
94fb342418 docs: Clarify up existing WSL environment discussion. 2024-11-27 14:44:46 -08:00
Apoorva Pendse
67a60829e6 docs: Add WSL rebuild steps.
Previously, the rebuild steps for WSL in the recommended setup guide
incorrectly just included the Vagrant instructions.

This commit fixes the issue by adding the appropriate steps to delete
the WSL instance using `wsl --unregister` in the docs.

Additionally, it includes steps to rebuild the development database,
which is a much faster alternative for folks who just want that.

Fixes #32402.
2024-11-27 14:33:18 -08:00
Apoorva Pendse
5fd872ba3f docs: Add note to use fresh instance of WSL.
This change ensures that developers use a fresh WSL instance when setting up the Zulip environment locally. Doing so helps prevent dependency and versioning conflicts.
2024-11-27 14:30:17 -08:00
Tim Abbott
f0422e07a4 docs: Update changelog for Zulip Server 9.3 release. 2024-11-22 17:21:20 -08:00
Lauryn Menard
919636be37 docs: Document generate-webhook-url-basic macro.
Fixes the create a channel macro point to link to an integration
doc that is still using that macro.
2024-11-19 13:02:01 -08:00
Lauryn Menard
22e3c80329 docs: Remove out of date or redudant macro information.
The `SITE` variable mentioned in the removed text seems to no
longer be part of the integrations system.

Removed the second bullet point documenting the macro to create
an incoming webhook instruction.
2024-11-19 13:02:01 -08:00
Tim Abbott
ffa7e0ac08 docs: Simplify Docker trade-offs discussion. 2024-11-18 16:37:50 -08:00
Tim Abbott
d8e02923e2 docs: Update changelog for changes merged into main. 2024-11-18 16:12:31 -08:00
Tim Abbott
fc7d305791 docs: Improve opening for recommended setup page. 2024-11-15 15:09:18 -08:00
Anders Kaseorg
905fc3b50e marked: Rename to *.cjs.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2024-11-13 09:18:56 -08:00
Anders Kaseorg
687f1b1651 tests: Rename the Node tests to *.cjs.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2024-11-13 09:18:56 -08:00
Mateusz Mandera
e37f3cca07 docs: Fix upgrade instructions for Ubuntu 22.04->24.04.
Due to Ubuntu 22.04->24.04 doing an incompatible minor version
jump in rabbitmq-server, we need to work around the issue by removing
the rabbitmq-server package before upgrading to 24.04.

https://bugs.launchpad.net/ubuntu/+source/rabbitmq-server/+bug/2074309
2024-11-07 11:20:08 -08:00
Tim Abbott
81476308f5 docs: Stop describing Docker as experimental.
It's not an accurate descripton for an image that's been used in
production for many years, and we fully support.
2024-11-06 11:38:28 -08:00
Tim Abbott
990c0616d3 docs: Document 10.x postgres support. 2024-11-01 15:42:00 -07:00
Anders Kaseorg
2bb87aebec install: Remove PostgreSQL 12 support.
PostgreSQL 12 reaches end of life on November 14, 2024.

Signed-off-by: Anders Kaseorg <anders@zulip.com>
2024-11-01 15:33:31 -07:00
Tim Abbott
d37ebef0c0 docs: Fix typos in new contintuing work guide. 2024-11-01 11:28:29 -07:00