Commit Graph

276 Commits

Author SHA1 Message Date
Gajendra Malviya
11ad4811ba docs: Fix miscellaneous typos and grammar errors. 2026-05-29 21:41:34 +02:00
Alex Vandiver
26189578c6 docs: Rework schema migrations guide around the online-deploy model.
Most of what makes a Zulip migration tricky to write follows from
how Zulip Cloud deploys: staging and production share a database,
staging deploys first and runs the migration against the shared
DB, production deploys some time later, and Django processes
restart in a rolling fashion. Together these mean migrations must
be safe for the previous release's code to keep running against,
and that staging-time problems are also live production problems.

The previous version of this page didn't describe any of that,
and as a result didn't motivate most of the rules contributors
need to follow. Rework the page around the deploy model so each
rule traces back to a property of how migrations actually run on
Cloud.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-28 15:59:32 +08:00
Aman Agrawal
467b4047b8 provision: Add Fedora 44 support.
Fedora 44 ships Postgres 17 in PGDG and shares Fedora 43's package
list, so support is just a matter of accepting the new version in
the provision check.
2026-05-06 07:34:15 +05:30
Aman Agrawal
75afa9c055 provision: Replace Fedora 38 support with Fedora 43.
Fedora 38 reached end of life upstream; replace it with Fedora 43,
which ships dnf5 and a recent enough groonga to skip the source
build. Concretely, to make `tools/provision` run cleanly on
Fedora 43:

* dnf5 (Fedora 41+) dropped the `groupinstall` alias and no longer
  resolves the "Development Tools" display name, so switch the
  Fedora branch of `setup-yum-repo` to
  `dnf group install development-tools` (by group ID). Move the
  existing CentOS/RHEL `groupinstall` calls into their own branches
  so they keep working on yum/dnf4.

* Map Fedora 43 to PostgreSQL 17, and add `groonga-devel`,
  `xxhash-devel`, `meson`, and `redhat-rpm-config` to the Fedora
  package list. PGroonga 4.0.6 switched its build system to meson;
  on Fedora, PostgreSQL's `pg_config` exports CFLAGS containing
  `-specs=/usr/lib/rpm/redhat/redhat-hardened-cc1` and
  `-specs=.../redhat-annobin-cc1`, and without `redhat-rpm-config`
  the PGroonga build fails with "cannot read spec file".
  `xxhash-devel` is required because `xxhash-libs` is often pulled
  in transitively (by blosc2, pyarrow, etc.) without its headers,
  in which case meson detects libxxhash via pkg-config and skips
  the vendored fallback that would otherwise build it from source.

* Use the packaged groonga from Fedora's main repo (15.0.4 on
  Fedora 43, satisfying PGroonga 4.0.6's >= 14.1.0 requirement)
  instead of compiling groonga from source. This removes the only
  remaining caller of `scripts/lib/build-groonga` and the
  BUILD_GROONGA_FROM_SOURCE plumbing in provision.py, which the
  prior Fedora 38 path was the only user of.

Verified end-to-end on a Fedora 43 host and in a fresh fedora:43
podman container: setup-yum-repo, the package install, and the
PGroonga source build against the system groonga all complete
cleanly.
2026-04-25 22:27:34 -07:00
Anders Kaseorg
34ed22a117 install: Support Ubuntu 26.04.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2026-04-22 22:00:04 -07:00
PieterCK
1aa5338c28 social_auth: Add Discord as an authentication option.
Fixes part of #38149.

Co-authored-by: Kevin Chang <13548854+sf302@users.noreply.github.com>
2026-04-13 09:34:19 -07:00
apoorvapendse
a6bea22059 setup_docs: Use the usermod command for docker.
The Docker documentation[1] recommends using the
`usermod` command for adding a user to the `docker`
group.

The previous `adduser` command only worked for
Debian-based systems and is symlinked to
`useradd` on my Fedora 43 by default.

I also add the step to create the `docker` group
which wasn't present previously and is a pre-req
for adding $USER to the `docker` group.

[1]: https://docs.docker.com/engine/install/linux-postinstall/
Signed-off-by: apoorvapendse <apoorvavpendse@gmail.com>
2026-02-17 21:12:56 -05:00
Shubham Padia
72653b5136 docs: Add dev droplet instructions for SAML setup. 2026-02-04 14:42:15 -08:00
Pulkit Saraf
135115f56e docs: Clarify Docker group activation and daemon requirement.
Clarifies that adding a user to the docker group requires logging out
and back in (not a full reboot), and explains that Docker must be
running as a background daemon for Docker commands to work.
2026-01-14 10:26:49 -08:00
Alex Vandiver
b74c1f0d7a docs: Remove unused windows-10-or-11 label.
Introduced in eb2f1b4788, but also all references to the heading it
was replacing were removed in the same commit.
2025-12-12 09:15:36 -08:00
Apoorva Pendse
6c49641af6
setup_docs: Emphasize creation of a new WSL instance.
This should hopefully reduce the number of folks
who run into errors because of dependency version
conflicts while setting up their dev environment on WSL.

The earlier way this was mentioned was easy to
miss.

Fixes: https://chat.zulip.org/#narrow/channel/19-documentation/topic/Emphasize.20WSL.20fresh.20distribution.20requirement.20in.20setup.20docs/with/2310938

Signed-off-by: apoorvapendse <apoorvavpendse@gmail.com>
2025-11-25 09:55:29 -08:00
Evy Kassirer
bf4b808d80 setup-recommended: Be more clear about needing to turn gRPC FUSE back on. 2025-11-05 11:35:04 -08:00
Anders Kaseorg
ff15d746c3 install: Support Debian 13.
Signed-off-by: Anders Kaseorg <andersk@mit.edu>
2025-08-13 14:11:05 -07:00
Lauryn Menard
7953fd95a0 docs: Update links to go to zulip-flutter instead of zulip-mobile.
Updates the mobile beta testing link to go to the help center
instructions for installing a beta release of the mobile app.

Part of #35643.
2025-08-08 13:06:31 -07:00
apoorvapendse
cdb46fd3d1 dev_docs: Fix broken GitHub OAuth app link for orgs.
Signed-off-by: apoorvapendse <apoorvavpendse@gmail.com>
2025-06-05 17:33:13 -07:00
apoorvapendse
9912109e82 setup_docs: Add troubleshooting steps for WSL2.
This commit adds steps to troubleshoot errors encountered
because of certain services like postgresql not starting
on WSL2.

The common reason behind this is port conflicts with other
services running on some other WSL2 instance or the host
Windows system.

This commit provides a guide to handle these issues, and
also provides some additional tips to WSL2 users to avoid
facing these issues in the future.

Fixes #32718.
2025-05-20 10:53:21 -07:00
apoorvapendse
5b4f9a42b7 setup_docs: Use operating system tabs for troubleshooting errors. 2025-05-20 10:53:21 -07:00
Apoorva Pendse
24b47dd263 setup_docs: Extract common Windows VM errors to a shared file.
The assumption here is that VirtualBox is used only for Windows. This
is because we do not mention VirtualBox for Unix based platforms prior
to this troubleshooting errors section.

Prep for organizing common errors into operating systems tabs.
2025-05-20 10:53:21 -07:00
Apoorva Pendse
c51542e44c setup_docs: Extract common unix errors to a shared file.
Prep for organizing common errors into operating system tabs.
2025-05-20 10:53:21 -07:00
apoorvapendse
3116925a6f setup_docs: Extract common vagrant errors to a shared file.
This change is done as a prerequisite step to
eventually add tabs for different platforms
for the troubleshooting section.

The reason behind making this change is to group
the errors common to vagrant setup when using
either docker or VirtualBox backends which would
make it convenient to maintain in the future.
2025-05-20 10:53:21 -07:00
apoorvapendse
713bdb85d0 setup_docs: Update troubleshooting intro for Vagrant and WSL. 2025-05-20 10:53:21 -07:00
apoorvapendse
34d8f83cf5 setup_docs: Capitalize information points.
Fixes: https://github.com/zulip/zulip/pull/32719#discussion_r2081928031.
2025-05-20 10:53:21 -07:00
apoorvapendse
82846f89ca setup_docs: Deduplicate bug reporting steps.
This removes the bug reporting steps from
the intro of the setup tutorial, as it
is already present in the `Troubleshooting
and common errors` section.
2025-05-20 10:53:21 -07:00
Anders Kaseorg
d7556b4060 requirements: Migrate to uv.
https://docs.astral.sh/uv/

Signed-off-by: Anders Kaseorg <anders@zulip.com>
2025-02-24 22:29:24 -08:00
Alex Vandiver
d74e176cbe docs: Fix missing references. 2025-01-21 15:12:49 -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
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
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
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
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
fc7d305791 docs: Improve opening for recommended setup page. 2024-11-15 15:09:18 -08:00
Lauryn Menard
04e2728cb0 documentation: Revise uses of "e.g.," followed by a colon. 2024-07-09 13:41:44 -07:00
Lauryn Menard
32b2eb5f47 documentation: Modify cases of "[a-zA-Z] e\.g\.," for readability. 2024-07-09 13:41:44 -07:00
Lauryn Menard
62d452f983 docs: Add comma to all uses of "e.g." in contributor docs. 2024-07-05 15:36:24 -07:00
Sayam Samal
a7772f86a2 docs: Update CZO links from stream to channel in docs and comments.
Updates all the https://chat.zulip.org/#narrow/stream/ links in the
docs and comments to use the new /channel/ path. All these links are
for documentation/reference purposes only and thus, can be bulk-updated.

This commit is a part of the effort to rename stream to channel.
2024-06-11 10:44:31 -07:00
Alex Vandiver
5c2fd1de5a docs: Update Django links to our current version. 2024-05-24 10:18:37 -07:00
Aman Agrawal
1728a2c057 setup-recommended: Make user choose osxfs earlier to avoid failure.
Since the docker macOS setup doesn't work without this, it makes
sense for it to be just part of the setup instead of a thing
they fix after running into failure.
2024-05-20 22:46:22 -07:00
Lauryn Menard
24e5e03d3f docs: Update docs/development/ files to use channel.
Updates descriptive text that refer to Zulip channels in the
`docs/development` files to use channel instead of stream.

Part of the stream to channel rename project.
2024-05-20 11:23:23 -07:00
Ajay Singh
dc80f29b8a
docs: Fix typo. 2024-04-04 10:51:37 -07:00
Anders Kaseorg
70914b0475 Remove support for Ubuntu 20.04 and Debian 11.
Signed-off-by: Anders Kaseorg <andersk@mit.edu>
2024-04-01 13:27:39 -07:00
Anders Kaseorg
e535c96e40 Upgrade development environment to Ubuntu 22.04.
Signed-off-by: Anders Kaseorg <andersk@mit.edu>
2024-04-01 13:27:39 -07:00
Robert Dyer
eb2f1b4788 docs: Upgrade development environment page to use synced tabs.
This greatly reduces how much content for other platforms a reader has
to scroll past in order to get the development environment set up.
2024-03-22 16:54:57 -07:00
Robert Dyer
40bab84e8f docs: Fix some outdated links from development environment guide. 2024-03-22 16:54:57 -07:00
Robert Dyer
32c8d89eeb docs: Cleanup setup-recommended.md.
For consistency, using `console` instead of `bash` to show commands to run, and dropping the name "christie" from examples.
2024-03-15 17:37:34 -07:00
Robert Dyer
e367718283 docs: Refactor setup-recommended into includable files. 2024-03-15 17:37:34 -07:00
Anders Kaseorg
066ea3ebf9 install: Support Ubuntu 24.04.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2024-03-01 17:38:08 -08:00