Commit Graph

253 Commits

Author SHA1 Message Date
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
Karl Stolley
131c24b390 docs: Add warning about failed provisioning on macOS.
Fixes: #28370
2024-01-04 10:29:57 -08:00
Anders Kaseorg
e601d0ae7c models: Rename zerver/models.py to zerver/models/__init__.py.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2023-12-16 22:08:44 -08:00
Anders Kaseorg
839b04a253 docs: Update example run-dev output.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2023-12-16 22:08:44 -08:00
Divyansh Seth
ec36fc5605 docs: Update devlogin screenshot and url in development setup.
This commit replaces the old dev login screenshot with the new one.
This also replaces the default path that we mention in the docs to
localhost:9991/devlogin.
2023-12-06 18:04:54 -08:00
Tam Le
f8a74831b0 run-dev: Add flag to allow JSON requests through HTTPS proxy. 2023-10-12 17:59:29 -07:00
Arnold Mwesigye
54d2215f1b docs: Improve punctuation on remote.md. 2023-10-01 18:31:34 -07:00
Anders Kaseorg
9abb850cd9 docs: Use MyST syntax for Sphinx metadata.
https://myst-parser.readthedocs.io/en/latest/faq/index.html#sphinx-specific-page-front-matter

Signed-off-by: Anders Kaseorg <anders@zulip.com>
2023-09-12 10:34:03 -07:00
shu.chen
321776ac49 provision: Add provision support for Fedora 38.
Tweaked provision script to run successfully in Fedora 38 and
included a script to build the groonga libs from source because
the packages in Fedora repos are outdated.

There is a major version jump from the last supported version (F34)
which is EOL so references and support for older versions were
removed.

Fixes: #20635
2023-08-22 11:26:29 -07:00
Anders Kaseorg
b386cb5347 setup-recommended: Fix typographical issues.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2023-08-07 13:04:01 -07:00
Matthew Volpe
466db56118 docs: Fix missing space in setup-recommended.md.
Previously, there was a missing space in setup-recommended.md that I noticed when reading it.
2023-06-26 11:10:29 -07:00
Zixuan James Li
4a18552ff8 docs: Document and advocate systemd for WSL 2.
systemd makes it a lot convenient to run services required for Zulip's
development environment on WSL 2. Once enabled, `tools/start_service`
becomes unnecessary.

More info:
https://devblogs.microsoft.com/commandline/systemd-support-is-now-available-in-wsl/

Signed-off-by: Zixuan James Li <p359101898@gmail.com>
2023-06-12 10:58:11 -07:00
Anders Kaseorg
12310189ed install: Support Debian 12.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2023-05-18 11:52:22 -07:00
Karl Stolley
b6c656ed73 docs: Clarify python3 installation requirements.
This should help miscueing users into thinking that the provisioning
steps, etc. are a part of the python3 installation--which is now more
explicitly aimed at Centos, Fedora, and RHEL users.
2023-04-27 13:55:59 -07:00
Karl Stolley
e9315e67b8 docs: Move uninstall warning up top. 2023-04-27 13:55:59 -07:00
Anders Kaseorg
3a27b12a7d dependencies: Switch to pnpm.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2023-03-20 15:48:29 -07:00
Anders Kaseorg
43b4f10578 run-dev: Drop .py from script name.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2023-03-03 18:02:37 -08:00
Anders Kaseorg
c1675913a2 web: Move web app to ‘web’ directory.
Ever since we started bundling the app with webpack, there’s been less
and less overlap between our ‘static’ directory (files belonging to
the frontend app) and Django’s interpretation of the ‘static’
directory (files served directly to the web).

Split the app out to its own ‘web’ directory outside of ‘static’, and
remove all the custom collectstatic --ignore rules.  This makes it
much clearer what’s actually being served to the web, and what’s being
bundled by webpack.  It also shrinks the release tarball by 3%.

Signed-off-by: Anders Kaseorg <anders@zulip.com>
2023-02-23 16:04:17 -08:00
Dhruv Gupta
03c70cbed5 docs: Spell out ./tools/run-dev.py in setup instructions.
This location in the documentation, in particular, is one where it's likely
to be helpful to spell the full path to the command when explaining it.
2023-01-30 14:32:53 -08:00
Tim Abbott
9b40bf804c docs: Clarify opening of direct installation section.
Fixes #23615.
2022-11-22 15:54:09 -08:00
Anders Kaseorg
f992116d9f docs: Fix extra period typo.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-09-23 14:46:06 -07:00
David Rosa
02eec29433 docs: Rename setup-vagrant.md -> setup-recommended.md.
Renames the filename so that it accurately reflects its contents
given the changes to the "Recommended setup" page in the previous
commit, and updates all links accordingly.
2022-09-15 15:54:14 -07:00
David Rosa
cdc9a64c21 docs: Fix development environment setup on Windows.
Windows users end up having to follow an odd chain of links because
the recommended installation instructions live on a different
page than the rest of the instructions about the environment setup.

All the tutorials about recommended install prerequisites for each
platform should be on the same page.

This moves the section about using WSL 2 from the advanced setup page
to the recommended environment setup tutorial page.

Renames sidebar and section titles to more accurately reflect the
information in the Recommended setup vs. the Advanced setup page.
Updates relevant text and links accordingly.

Fixes: #13696.
2022-09-15 15:54:14 -07:00
Robert Imschweiler
8723931236 vagrant: Add Fedora 36 support.
- Add documentation for the vagrant setup on Fedora.
- Fix the container setup by adding the `z` option to the bind mounts so
that the selinux context allows sharing. This is according to the official
docker documentation:
https://docs.docker.com/storage/bind-mounts/#configure-the-selinux-label
https://www.vagrantup.com/docs/providers/docker/basics (section "Volume
Consistency")
2022-09-08 16:12:59 -07:00