Commit Graph

3258 Commits

Author SHA1 Message Date
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
Tim Abbott
315f9786dd docs: Extend section on crediting work. 2024-10-31 11:25:30 -07:00
Karl Stolley
892d9f2443 docs: Add section on crediting the work of others. 2024-10-30 12:36:58 -07:00
Karl Stolley
2436971b1b docs: Add edits to unifinished work guidance for clarity. 2024-10-30 12:36:58 -07:00
Alya Abbott
bc7b2e9c2e contributor docs: Link to new guide on continuing prior work. 2024-10-21 18:33:28 -07:00
Alya Abbott
649103a795 contributor docs: Add a page on taking over prior work. 2024-10-21 17:44:59 -07:00
Alya Abbott
b8dd409d71 help: Update exports documentation.
Document in-app exports with user consent.
2024-10-15 10:15:34 -07:00
evykassirer
269066e10a settings_org: Convert module to typescript. 2024-10-14 15:33:01 -07:00
Mateusz Mandera
b95225d071 docs: Minor tweaks to thumbnailing.md.
The first change fixes the incorrect claim that stills of animated
emojis are unused.
Second change just fixes the missing words in the sentence.
2024-10-13 11:43:28 -07:00
Lauryn Menard
240c4d85ae docs: Update existing links to use "channel" operator. 2024-10-11 17:00:23 -07:00
Karl Stolley
1f2ce2e7e6 left_sidebar: Use calendar-days icon with scheduled messages. 2024-10-09 11:14:27 -07:00
Alex Vandiver
1bd0ab506c nginx: Make uwsgi timeout shorter than nginx-to-uwsgi timeout.
The nginx-to-uwsig-timeout defaults to 60s, which is exactly the same
as the current "harakiri" timeout configured in uwsgi (which limits
the length a request can run before the worker is terminated).  This
causes a race, where if nginx hits its 60s before uwsgi, then we
return a 504; otherwise, we get a 502.

Make the nginx-to-uwsgi timeout explicit, and shorten the "harakiri"
timeout to be explicitly less than that.  Document the 60s timeout,
which all outer reverse proxies must be set to _longer than_ in order
to have proper "onion" timeouts.
2024-10-07 15:41:08 -07:00
Lauryn Menard
957186adff help: Link to "Moving to Zulip" guide in help center and prod docs.
In the help center and production documentation, replace links to
the "Getting your organization started with Zulip" guide to the
new "Moving to Zulip" guide.
2024-09-30 11:58:31 -07:00
Lauryn Menard
9f3553815e help: Link to dedicated articles vs getting org started guide.
As the guide to getting an organization started is being replaced
by the moving to zulip guide, replace links to subsections of the
old guide to instead go to dedicated articles about those topics.
2024-09-30 11:58:31 -07:00
Tim Abbott
4b25425adf docs: Document max upload size setting. 2024-09-23 16:36:59 -07:00
Alex Vandiver
e125ad823d exports: Add a separate bucket for realm exports.
This allows finer-grained access control and auditing.  The links
generated also expire after one week, and the suggested configuration
is that the underlying data does as well.

Co-authored-by: Prakhar Pratyush <prakhar@zulip.com>
2024-09-20 15:43:49 -07:00
Tim Abbott
51d0dfb504 docs: Tweak some documentation around send_event. 2024-09-20 15:28:18 -07:00
Prakhar Pratyush
a7f48e260c docs: Rename 'send_event' to 'send_event_on_commit'.
This commit updates the doc to rename the 'send_event' function
to 'send_ecent_on_commit'.

This is required as we no longer have the send_event function
and we prefer to use 'send_event_on_commit' in most cases and
'send_event_rollback_unsafe' in a few.
2024-09-20 15:20:18 -07:00