Commit Graph

238 Commits

Author SHA1 Message Date
Tim Abbott 5371589c76 setup-advanced: Remove broken links for old tsearch_extras packages.
It appears Luke's Dropbox folder/shared link that used to host some
tsearch_extras binaries was removed.  It wasn't very high-value
regardless, because most of the platforms involved are deprecated, the
ones that don't generally have a PPA, and building from source is
pretty easy.  So, we just remove these options from the documentation.

While we're at it, make clear we only support direct installation on
Ubuntu LTS.

Fixes #9863.
2018-07-11 21:35:23 +05:30
Tim Abbott 8c100f45f0 docs: Update development environment docs for Ubuntu bionic.
We also clean up some flows in the documentation that were somewhat
confusing that I noticed while working on this.
2018-05-30 10:00:41 -07:00
amanagr 7797c746fc docs: Update installation instructions for Ubuntu 18.04.
Add missing dependencies for installation of dev server in
Ubuntu 18.04.
2018-05-25 08:50:14 -07:00
Abhigyan Khaund fda786952e documentation: Migrate all CZO stream links to new stream URL style
This includes changes like changing CZO stream URLs from new.20members
to 95-new-members.
2018-05-24 15:15:34 -07:00
Tim Abbott a0e24e6d1f setup-advanced: Improve discussion of manual instructions.
First, make them even less recommended.  But also, remove the list of
packages at the top -- it's not actually useful.
2018-05-24 09:47:18 -07:00
Tim Abbott 54c91ebdc0 setup-advanced: Remove direct nodejs documentation.
We already install this via `install-node` further on.
2018-05-24 09:45:55 -07:00
amanagr 3818a0ca3d docs: Update dev server manual installation instructions.
Update instructions for setup in ubuntu 18.04.
2018-05-24 07:37:07 -07:00
Tim Abbott 63a01d35e1 docs: Remove now-obsolete trusty64 box instructions.
This annoying Vagrant bug hasn't been super relevant for over a year.
2018-05-17 07:33:24 -07:00
Tim Abbott 958be1ebb6 docs: Clarify Vagrant version recommendations. 2018-05-17 07:30:24 -07:00
Tim Abbott c9c17bb018 docs: Fix a couple broken links.
These were broken when we added Debian/Ubuntu support.
2018-05-16 15:00:54 -07:00
Hendy Irawan bb5457c2f7 docs: Clarify need to provision from /srv/zulip when troubleshooting.
Text tweaked slightly by tabbott.
2018-05-15 09:43:09 -07:00
Yago González a575d69eec docs: Improve dev env setup for Debian. 2018-05-13 15:02:48 -07:00
Yago González 5e85701a42 docs: Add references to dev installation in Debian. 2018-05-07 08:53:01 -07:00
Tim Abbott 8a3522e8e4 docs: Update development docs for Debian support.
While we're at it, we also update some direct download links for
Debian/Ubuntu packages.
2018-05-05 11:08:07 -07:00
Tim Abbott a65f6288b6 docs: Fix a broken link to the Cloud9 documentation. 2018-04-01 22:13:38 -07:00
gooca 64dac1bb2e Docs: Added "connect the zulip upstream repo" to more places. 2018-03-18 23:02:09 -07:00
Tim Abbott a3e60ed3b4 docs: Update setup docs for postgres extensions.
Fixes #8494.

Further work is required to properly support newer Ubuntu.
2018-03-16 13:45:13 -07:00
Tim Abbott c7b560cdc2 docs: Clarify documentation of remote development environment. 2018-03-13 09:45:37 -07:00
feorlen 4631a2bfc3 Set REALM_HOSTS based on EXTERNAL_HOST if it is available.
Also update remote.md to recommend setting EXTERNAL_HOST in an environment
variable.

Fixes #8670
2018-03-13 09:45:37 -07:00
cPhost 7f144b9b95 setup-non-vagrant: Document how to setup zulip dev env on cloud9.
Significantly tweaked by tabbott for instructional clarity.
2018-03-03 15:43:38 -08:00
knovokresch eb7a744639 docs: Extend troubleshooting guide to cover MacOS High Sierra issue.
Significantly tweaked by tabbott to provide more clarity about the
bug, and also link to this issue early in the MacOS requirements
sections.
2018-03-03 08:37:26 -08:00
Greg Price 49252c97d2 docs: Fix explanation of Debian LXC installation.
This didn't really make much sense - it presented a quickstart summary
of the instructions as an item in the list of differences from the
Ubuntu case, plus that quickstart only incorporated one of the two
actual differences so it didn't work anyway.  Given the networking
stuff, an actual quickstart isn't in the cards, so just cut that.

Also fix some small things while we're here.
2018-02-27 17:16:31 -08:00
Tim Abbott db88634bcf docs: Better document how Debian LXC installation works.
This fixes an issue where users would try to setup LXC networking
before installing the LXC package.

Fixes #8503, thanks to @Shobitha-M for reporting.
2018-02-24 07:45:58 -08:00
Shivam Gera 2733c0551e docs: Add VT-X unavailability error 2018-02-18 08:09:55 -05:00
Aman Agrawal 0db9f55924 Update versions for Vagrant and VirtualBox.
Update version of Vagrant from 1.8.6 to 2.0.2.
Update version of VirtualBox from 5.1.8 to 5.2.6.

We needed to update Vagrant because older versions have networking
problems on modern Macs, resulting in weird `apt` errors when
provisioning.

Commit message and some text tweaked by tabbott.
2018-02-12 15:46:59 -08:00
Greg Price edfa3eabfd docs: Use `orphan` to directly exclude pages from toctree.
This is what the Sphinx docs recommend when you actually don't want
the page to be included in navigation:
  http://www.sphinx-doc.org/en/stable/markup/toctree.html
And now that we have `eval_rst`, we're able to take advantage of it!

One difference between doing this and the old way of making "hidden"
toctree entries is that with the latter, the "previous" and "next"
links at the bottom of each page would thread through the hidden
entries; which gets kind of confusing when they don't appear in the nav.
2018-01-24 14:37:17 -08:00
Jeremy Zhou 48163db479 docs: Update Windows installation instructions in setup-vagrant.md.
Vagrant 1.8.6 is only compatible with VirtualBox <= 5.1, so I made a
note to use version < 5.2.
2017-12-20 19:16:25 -08:00
Greg Price d4f0c4dffc docs: Restore Docker links, updated.
Previous versions of these links were removed earlier today because
Docker upstream had broken them.

To see what the links had been intended to point to, I used the
Wayback Machine (web.archive.org/web), the super-handy project of the
Internet Archive.  These are the current equivalents.
2017-12-20 11:16:50 -08:00
Steve Howell 70681628ca docs: Remove broken Docker links. 2017-12-20 09:24:43 -05:00
itstakenalr 90c71f3ca6 docs: Update request-remote.md.
Change (zulip-venv) to (zulip-py3-venv)
2017-12-16 01:10:26 -08:00
Harshit Bansal fa3602b61f docs: Split 'git-guide.md`.
This should make our Git documentation more readable and less
intimidating.
2017-11-23 16:04:18 -08:00
David Rosa Tamsen 84384196f2 docs: Exclude files from TOC warnings and navigation sidebar.
Sphinx was displaying "WARNING: document isn't included in any toctree"
for files we just don't want in the TOC. We can hide them from the index,
but the rtd theme defaults to display hidden index entries in the nav bar.

This commit excludes these files from such warnings, and patches layout.html
so that hidden index entries stay hidden from the navigation sidebar.

This commit also moves password-strength.md under docs/production and
adds it as a hidden entry in production/index.rst.

Fixes #7417.
2017-11-22 10:59:14 -08:00
rht bff736868e Generate custom-icon-webfont on each provision or update-prod-static.
Fixes #7354.
2017-11-20 16:36:49 -08:00
Harshit Bansal e75f0c1ee4 requirements: Rename requirements files.
This commit renames various source requirements files like `dev.txt`,
`mypy.txt` etc to `dev.in`, `mypy.in` etc and various locked requirements
files like `dev_lock.txt`, `mypy_lock.txt` etc to `dev.txt`, `mypy.txt`
etc. This will help in emphasizing to the user that *.in are actually
input to `update-locked-requirements` tool which should be run after
updating any of these.
2017-11-21 02:38:26 +05:30
Tim Abbott e81b64d511 docs: Move remotedev docs to docs/development/ and fix links.
Thanks to SivagiriVisakan for pointing out the issues here; I ended up
redoing this since the doc really belongs in that directory.
2017-11-20 11:13:59 -08:00
Mohd Ali Rizwi 66d658d7f1 docs: Use `git clone -c` to set `git pull` to rebase by default.
This updates the developer documentation to recommend `git clone -c`
to set the git pull mode to be rebase by default in the repository
configuration.

The hope is that this will help minimize how often new contributors
end up accidentally messing up their PRs by using `git pull`.

Tweaked by tabbott to fix broken links and optimize the language.

Fixes: #7022.
2017-11-16 14:35:02 -08:00
KiranS 92caa4abab docs: Add more troubleshooting cases to Vagrant guide. 2017-11-16 14:12:38 -08:00
David Rosa Tamsen 7072fa5b37 docs: Reorganize developer docs to improve navigation.
This commit helps reduce clutter on the navigation sidebar.
Creates new directories and moves relevant files into them.
Modifies index.rst, symlinks, and image paths accordingly.

This commit also enables expandable/collapsible navigation items,
renames files in docs/development and docs/production,
modifies /tools/test-documentation so that it overrides a theme setting,
Also updates links to other docs, file paths in the codebase that point
to developer documents, and files that should be excluded from lint tests.

Note that this commit does not update direct links to
zulip.readthedocs.io in the codebase; those will be resolved in an
upcoming follow-up commit (it'll be easier to verify all the links
once this is merged and ReadTheDocs is updated).

Fixes #5265.
2017-11-16 09:45:08 -08:00