Commit Graph

14 Commits

Author SHA1 Message Date
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
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
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
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
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
Ajay Singh
dc80f29b8a docs: Fix typo. 2024-04-04 10:51:37 -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
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