Commit Graph

1103 Commits

Author SHA1 Message Date
rht 6142a70dc7 docs: Update architecture-overview to point to Python 3.x. 2018-01-17 13:04:11 -05:00
Steve Howell b403897ef9 Fix broken doc links for Python Markdown library. 2018-01-09 08:33:36 -05:00
XavierCooney 5409a98039 docs: Fix typo in multiple-organizations.md. 2017-12-31 09:11:30 -05: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
Greg Price 73a5c39264 docs: Fix link in roadmap.
Caught by tools/test-documentation .
2017-12-12 20:50:36 -08:00
Greg Price c2cd76b69e docs: Note need to log out and in again on push notifs setup.
This often surprises people, so mention it up front.

(Also it'd probably be good to add some code to make this step
unnecessary.)
2017-11-29 13:32:02 -08:00
YJDave 967ef04c1e docs: Fix typos in event-system document.
Tweaked by tabbott to fix these typos properly.
2017-11-29 09:31:16 -08:00
Greg Price 5b73c54a74 docs: Push all extraneous level-1 headings inward.
This prevents internal headings like "Basic Example" from appearing in
the left nav at the same level as all the various subsystems.
2017-11-28 21:45:11 -08:00
Greg Price dc8cb0b436 docs/git/pull-requests: Give headings more hierarchy.
This prevents the sub-heading "Update a pull request" from appearing
as a separate item in the nav.
2017-11-28 21:44:23 -08:00
Greg Price c7a9f2f4eb docs: Give docs on docs a clearer heading for navigation.
The old name sounds like it's going to be an index or table
of contents for reading the documentation.
2017-11-28 21:35:28 -08:00
Tim Abbott 5dedb488e6 roadmap: Rewrite roadmap to no longer point to milestones. 2017-11-28 16:56:23 -08:00
Rishi Gupta 191f8f1b39 left sidebar: Change Home to All messages.
We made this change because users often unnecessarily click "Home"
first in their use of Zulip, because it seems appealing.  While "All
messages" isn't quite precise (it doesn't include muted streams), it
does describe relatively simply the interleaved view that this
represents.

This commit leaves everything as "home" in the code, and only changes
user-visible strings and docs. Changing the code will be a big project;
there are hundreds of relevant occurrences in variable names, etc.

Further, we'll probably want to convert those various variable names
in different ways.

Tweaked by tabbott to extend the commit message and update a few comments.
2017-11-28 15:42:58 -08:00
Tim Abbott cb8f2cf484 git cheat sheet: Be a bit less agressively anti-git-pull.
Now that we configure pull.rebase, it's less necessary.
2017-11-28 09:15:13 -08:00
Rohitt Vashishtha c073af0ddc git-docs: Highlight Zulip's git scripts in overview. 2017-11-28 09:07:25 -08:00
Rohitt Vashishtha 106cc71c19 docs: Add external documentation for markdown subsystem.
Tweaked by tabbott to move the content earlier in the doc.
2017-11-28 09:07:17 -08:00
Rohitt Vashishtha a2d1ebc091 git-docs: Refine git-cheat-sheet with more examples. 2017-11-28 09:02:50 -08:00
Tim Abbott c3c978e55d docs: Document the new queue_json_publish model in our unit tests. 2017-11-26 11:49:42 -08:00
Rohitt Vashishtha cd83b94f3d git-docs: Make links to Zulip's git-tools at relevant places.
Tweaked by tabbott to fix a few issues with the text found while
looking at this.
2017-11-26 11:14:16 -08:00
Rohitt Vashishtha a9e915007a git-dogs: Move working-copies to docs/git. 2017-11-26 09:15:50 -08:00
Rohitt Vashishtha e2c1cf6832 git-docs: Move fixing-commits to docs/git. 2017-11-26 09:15:50 -08:00
Rohitt Vashishtha e811675831 git-docs: Merge two cheat-sheets and move to docs/git. 2017-11-26 09:15:50 -08:00
Rohitt Vashishtha ae0732e4f2 git-docs: Fix typos and make minor edits to working-copies. 2017-11-26 09:15:50 -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
Greg Price 49f4c33a57 docs: Update release checklist with thoughts from 1.7.1. 2017-11-22 18:11:20 -08:00
Greg Price 50ea5ff4b1 version: Update mentions of latest release to reflect 1.7.1. 2017-11-22 18:11:20 -08:00
Greg Price fbbd5b0eee changelog: Document 1.7.1 release. 2017-11-22 18:11:20 -08:00
Vishnu Ks b9fc4a4306 docs: Mention the error when phantomjs is not installed. 2017-11-22 12:42:02 -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
David Rosa Tamsen 11b8b8f483 docs: Add rtd layout template.
The readthedocs theme overrides a few settings in their layout template.
We might want to change some settings back to their default values.

This commit copies the original readthedocs layout file from
https://github.com/rtfd/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/layout.html
to _templates/layout.html, and excludes it from lint and template checks.

Addresses #7417.
2017-11-22 10:59:14 -08:00
rht e169bb0954 zerver: Remove simplejson dependency.
Modified by tabbott to put the third-party code in a new file.

Fixes #6970.
2017-11-21 21:51:48 -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
David Rosa Tamsen 327bb05733 docs: Make index page easy to find.
This commit adds an Index link to bottom of nav bar.

Fixes #7416.
2017-11-20 16:33:04 -08:00
Greg Price 0b543bfc0e docs: Rewrite certbot discussion, to enjoy the new automation.
This doesn't touch the main path through the install docs; that will
see a broader rewrite soon as we make outbound email optional for a
nascent server, make the hostname and admin email into mandatory
installer flags, and then radically simplify the instructions by
removing mandatory editing of `settings.py` and folding most of what's
left into the installer.
2017-11-20 15:52:07 -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
Harshit Bansal 95b3f2e745 requirements: Add mypy.txt and docs.txt to locked requirements framework. 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
Balaji2198 489feaf139 docs: Add a few more articles to subsystems TOC.
These are subsystems documentation, which was accidentally not listed
in the TOC.
2017-11-20 10:22:06 -08:00
Balaji2198 d6fb70e8dc docs: Move users.md to subsystems/ and give it a title.
Edited by tabbott to improve the users.md title and update the TOC in
this commit.
2017-11-20 10:21:53 -08:00
Balaji2198 1f43252903 docs: Update TOC in production to include SSL and email.
This adds a few missing entries to the TOC, which hadn't made sense
back when Zulip's ReadTheDocs didn't have the new collapsing feature.

Tweaked by tabbott to also give the SSL certificates doc an
appropriate title for its new role.
2017-11-20 10:21:02 -08:00
Balaji2198 c3ac9894a5 docs: Move migration-renumbering.md to subsystems/.
It belongs in that part of the documentation.  We also update the
links in docs/subsystems/schema-migrations.md.
2017-11-20 10:20:31 -08:00
Balaji2198 a5e605d73c docs: Delete brief-install-vagrant-dev.md
This was the old version of our installation docs, and hasn't been
used or updated in about a year.
2017-11-20 10:20:15 -08:00
Tommy Ip 02be1a11cc docs: Document Firefox's screenshot feature. 2017-11-20 10:01:13 -08:00
Tim Abbott 46ba76e245 Fix broken link to GitHub CONTRIBUTING guide. 2017-11-19 20:31:27 -08:00
David Rosa Tamsen a6510c4626 docs: Remove integration docs from tutorials/index.
Merged PR 7414 moved integration docs to /api, so
this commit updates tutorials/index.rst accordingly.
2017-11-17 18:44:54 -08:00
Tim Abbott b2637c8400 docs: Fix broken link due to integration guide migration. 2017-11-17 12:25:33 -08:00
derAnfaenger 73915a9631 docs: Move integration docs to /api. 2017-11-17 11:58:54 -08:00
David Rosa Tamsen 4906bc8e4a docs: Prevent readthedocs from overriding collapse_navigation setting.
Expand bullets "[+]" show up on locals instance, but they
do not show up online on readthedocs. The expand icon is valuable
to indicate that each section has more content.

The problem is readthedocs appends code to conf.py that overrides the
html_theme_options prior to a build. This commit prevents this from
happening so that collapse_navigation remains set to False.

In response to merged PR 7326.
2017-11-17 11:28:37 -08:00