Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
27,361 Commits 28 Branches 143 Tags 605 MiB
Commit Graph

104 Commits

Author SHA1 Message Date
Christie Koehler 3913db9022 docs: Simplify hierarchy of dev setup docs. 
Based on feedback from first-time contributors, this commit simplifies
the number of paths available for finding the dev setup directions you
need. Setup instructions are now organized into Recommended (Vagrant)
and Advanced (non-Vagrant).

In order to get the ToC to display correctly, I've combined all the
advanced, non-Vagrant methods into one page. I've left the old pages
intact, with a note that the content has been moved and link to the new
page. This is in case folks have linked directly to those pages.

The advanced setup directions still need to be cleaned up, but this is a
start.
 2016-11-29 14:13:09 -08:00
Pweaver (Paul Weaver) b986cf9c41 docs: add a tutorial for setting up a remote dev environemnt 2016-11-20 12:38:14 -08:00
Tim Abbott 945c2c4f86 docs: Add a brief release checklist. 2016-11-04 10:52:48 -07:00
hackerkid 1e409032bd docs: Add subsystem section discussing realms and subdomains. 2016-11-01 10:49:47 -07:00
Tim Abbott a32eaf28c0 docs: Remove broken indices and tables index section. 
None of these links worked properly.
 2016-10-22 19:23:11 -07:00
Sumana Harihareswara d9d389f64f docs: Add an initial code review document. 
A first pass at a code review guide. Mostly Tim's draft; I added
polish and links.

Fixes: #758.
 2016-10-20 22:41:38 -07:00
Christie Koehler 23df7913d5 docs: Add Git and GitHub Guide. 
Fixes #783, #1754.
 2016-10-17 16:18:16 -07:00
Sahil Dua 058587da77 Remove extra new lines at the ends of Zulip authoried files. 
Fixes #1627.

[tweaked by tabbott to avoid patching third-party modules, for now]
 2016-09-26 21:05:24 -07:00
Steve Howell c8e37f30d2 docs: Add "Custom Apps" to "Subsystem Documentation". 2016-08-27 11:30:57 -07:00
Tim Abbott f6c4e46afe docs: Move README.dev.md into ReadTheDocs. 
Fixes: #669.
 2016-08-25 10:40:51 -07:00
Tim Abbott d876909b69 docs: Clean up development environment headings. 2016-08-25 10:40:51 -07:00
Tim Abbott c0e68d59cb docs: Rename status/debug page to troubleshooting. 2016-08-25 09:37:33 -07:00
Tim Abbott 8086cc549f docs: Merge prod-auth-first-login into main installation page. 2016-08-25 09:37:33 -07:00
acrefoot 920e605e17 Add extensive views writing documentation. 
[section on REQ substantially expanded by tabbott]

Fixes: #880.
 2016-08-18 12:37:33 -07:00
Sumana Harihareswara 1a9f961bb4 doc: Add pointer and unread counts guide. 
Tim's comments in #789 are useful to developers
in explaining message selection at browser load,
narrow, etc.
 2016-08-16 16:15:38 -07:00
Sumana Harihareswara d97702ead6 De-duplicate testing docs. 
Addresses comment in #1218.
 2016-08-02 19:26:59 -04:00
acrefoot 38bf0bf39b Add Life of a Request doc (#1302) 
This doc follows the different layers that Zulip uses
to handle a request, detailing parts of those layers that
would be most commonly interesting to developers.
 2016-07-20 17:12:15 -07:00
Sumana Harihareswara 5473b03e3b Split out generic UNIX developer install doc. 2016-07-19 14:57:07 -07:00
Sumana Harihareswara 9aba0f84a8 Split non-Vagrant Ubuntu install doc into topic page. 2016-07-19 14:57:07 -07:00
Sumana Harihareswara cf7b1af508 Split developer environment usage instructions into new page. 2016-07-19 14:57:07 -07:00
Sumana Harihareswara c40ffd9538 Split out docker setup doc. 2016-07-19 14:57:07 -07:00
Sumana Harihareswara 97ff43e972 Move and rearrange vagrant instructions. 2016-07-19 14:57:07 -07:00
Sumana Harihareswara b95370f833 Move and rearrange developer setup instructions. 
We aim to consolidate developer documentation on Read The Docs. As a
start, this commit turns the first part of README.dev.md into a topic
page within /docs/ , and links to it from the doc index.

See #669.
 2016-07-19 14:57:07 -07:00
Tim Abbott 6301fd22dc docs: Turn SSO auth documentation into general auth page. 
Also remove this page from the breadcrumb.
 2016-07-12 16:19:13 -07:00
Sumana Harihareswara 260baff4db Move prod postgres details to separate page. 2016-07-12 15:46:10 -07:00
Sumana Harihareswara 3a13cf1865 Move prod remote user SSO auth guide to new page. 2016-07-12 15:46:10 -07:00
Sumana Harihareswara bfa81a80ad Move prod maintenance guide to new page. 2016-07-12 15:46:10 -07:00
Sumana Harihareswara 76fea4f4d4 Move prod customization guide to new page. 2016-07-12 15:46:10 -07:00
Sumana Harihareswara 07afc9d34b Move production health check doc to separate page. 2016-07-12 15:46:10 -07:00
Sumana Harihareswara ec005726c4 Move prod auth and first login doc to new page. 2016-07-12 15:46:10 -07:00
Sumana Harihareswara 7d092d2cc4 Move production install instructions to new page. 2016-07-12 15:46:09 -07:00
Sumana Harihareswara 3f90f9e29e Move production installation requirements to separate page. 
To begin the process of consolidating Zulip documentation on Read
the Docs, the requirements are now their own topic page, and
index.rst links to it.

Fixes: #669.
 2016-07-12 15:43:06 -07:00
Tim Abbott 879ca4b9ea docs: Add documentation on HTML and CSS. 2016-06-27 12:38:53 -07:00
Tim Abbott dc014b0866 docs: Add link to documentation building docs. 2016-06-26 10:04:07 -07:00
Tim Abbott 1838cd4d8f docs: Split out version control guidelines. 2016-06-26 10:04:06 -07:00
Tim Abbott 96fef7a0a1 docs: Reorganize RTD table of contents. 2016-06-26 10:04:05 -07:00
Tim Abbott ea611c0dcd docs: Add some full-text search documentation. 2016-06-26 09:32:54 -07:00
Sumana Harihareswara 4a10923bf1 Add architectural overview documentation. 
Fixes: #453.
 2016-06-03 11:54:02 -07:00
Sumana Harihareswara e0bc57ddb1 Rearrange docs table of contents for coherence. 
The order and structure of the Read The Docs documentation
was fairly arbitrary; here's a suggestion for how to change
its information architecture so it's more useful to a new
contributor. This adds a short Zulip overview, and a table
of contents and code contribution intro for new contributors.

Fixes: #668.

Signed-off-by: Sumana Harihareswara <sumanah@panix.com>
 2016-05-31 09:07:09 -07:00
Christie Koehler e06492ec3a Improve first-time contributor docs. 
Fixes #747. Fixes #748.

This updates README.dev.md to include clear, step-by-step instructions
for setting up the Zulip dev environment Windows 10, OS X El Capitan,
Ubuntu 14.04 Trusty, and Ubuntu 16.04 Xenial. It is aimed at first-time
contributors.

I tested these instructions multiple times on each of the target
systems.

Also added is a "trobleshooting and common errors" section which
documents the most common errors contributors are likely to encounter
during setup and how to fix them.

Improvements based on feedback from @timabbott.

- Fixes whitespace issues so linter will pass.
- Updates memory requirement.
- Re-orders so operating systems are listed alphabetically.
- Updates headings to be clearer.
- Updates and adds ToC entries for clarity.
- Adds screen shot of Zulip dev environment running in browser.
- Adds details about using dev environment, including about logging.
- Misc other minor changes for clarity.
- Adds a stub for docs/logging.md
- Adds details about configuring Cygwin for native symlinks.
 2016-05-31 07:47:45 -07:00
Tim Abbott 1c24cb32a5 Move changelog.md to docs/ and add to ReadTheDocs. 2016-05-07 20:26:44 -07:00
Tim Abbott 362a622f1f Add documentation on translating Zulip. 2016-04-28 21:57:10 -07:00
Tim Abbott 27b8e8b294 Add the Zulip 2016 roadmap document. 2016-04-28 21:55:33 -07:00
Eklavya Sharma b60141fd84 Add documentation on the using the mypy static type checker. 
[with substantial tweaks by tabbott]
 2016-04-28 12:29:45 -07:00
Tim Abbott 5c810ad0bc Add new markdown documentation to ReadTheDocs. 2016-04-01 14:57:30 -07:00
Allie Jones 11c69fb0b2 Add documentation on the front end build process and webpack. 2015-11-20 20:32:01 -08:00
Tim Abbott a3c122eb41 Remove largely obsolete documentation pages. 
(imported from commit eb02c24dd25a12a5676b5e52c914993650f73aa6)
 2015-09-22 22:37:45 -07:00
David Roe c17e50e0c4 Add new feature tutorial. 
(imported from commit 1577c2567232aba1a1f1c6d1df83370acf54af55)
 2015-08-22 12:56:57 -07:00
David Roe 33b7b2d021 Add welcome.rst with info for new developers. 
(imported from commit 14e27efc47cfb0802f16ec5d2d6c5eadeba7a2c2)
 2015-08-22 12:54:20 -07:00
Yoyo Zhou 4a6e132a44 Add "Schema changes", rST generated via pandoc -r mediawiki -w rst 
(imported from commit f3c5621a8b612217986c879d3d15b85c9098ccca)
 2015-08-20 14:24:59 -07:00
Yoyo Zhou bb45f8d8e3 Copy "Testing the app" from the wiki, via pandoc -r mediawiki -o rst 
(imported from commit 7150179ff1008ffa6849b983fb579a36fffc9c06)
 2015-08-20 14:21:55 -07:00
Yoyo Zhou 1629e77174 Directory structure generated from pandoc, with formatting fixes 
(imported from commit d54bb062b641bac0520494f0a2cb151d69018d61)
 2015-08-19 11:52:49 -07:00
Yoyo Zhou 8461048a11 Add 'Code style', generated via pandoc -r mediawiki -w rst and html_unescape.py 
With a basic README.md

(imported from commit 91728b2c591bc88b7bee520669cb0b3f53426cd8)
 2015-08-18 17:34:02 -07:00
Yoyo Zhou ac63d942ce Initial sphinx setup from sphinx-quickstart 
(imported from commit b9fc7a8f2f9352129c104f5dc9305203f2efc63d)
 2015-08-18 17:31:32 -07:00