Fix typos in the documentation.

Pushing this now so as to not create merge conflicts with others working on
the prod docs.
This commit is contained in:
Rishi Gupta
2016-07-26 19:00:29 -07:00
committed by Tim Abbott
parent c51b5bced8
commit e515484c41
5 changed files with 19 additions and 18 deletions

View File

@@ -44,7 +44,7 @@ similar groups ranging in size from a small team to more than a thousand
users. It features real-time notifications, message persistence and
search, public group conversations (*streams*), invite-only streams,
private one-on-one and group conversations, inline image previews, team
presence/a buddy list, a rich API, Markdown message support, and several
presence/buddy list, a rich API, Markdown message support, and numerous
integrations with other services. The maintainer team aims to support
users who connect to Zulip using dedicated iOS, Android, Linux, Windows,
and Mac OS X clients, as well as people using modern web browsers or
@@ -147,7 +147,7 @@ Tornado and Django are set up, as well as a number of background
processes that process event queues. We use event queues for the kinds
of tasks that are best run in the background because they are
expensive (in terms of performance) and don't have to be synchronous
-- e.g., sending emails or updating analytics. Also see [the queuing
--- e.g., sending emails or updating analytics. Also see [the queuing
guide](queuing.html).
### memcached

View File

@@ -31,7 +31,7 @@ paths will be familiar to Django developers.
* `zerver/lib/bugdown/` [Backend Markdown processor](markdown.html).
* `zproject/backends.py` [Authenticate backends](https://docs.djangoproject.com/en/1.8/topics/auth/customizing/).
* `zproject/backends.py` [Authentication backends](https://docs.djangoproject.com/en/1.8/topics/auth/customizing/).
-------------------------------------------------------------------
@@ -139,7 +139,7 @@ This is used to deploy essentially all configuration in production.
* `confirmation` Email confirmation system.
* `analytics` Analytics for Zulip server administrator (needs work to
* `analytics` Analytics for the Zulip server administrator (needs work to
be useful to normal Zulip sites).
* `corporate` The old Zulip.com website. Not included in production

View File

@@ -67,7 +67,7 @@ Zulip app that lets you deactivate other users, manage streams, change
the Realm settings you may have edited using manage.py shell above,
etc.
You can also use `manage.py knight` with the
You can also use `./manage.py knight` with the
`--permission=api_super_user` argument to create API super users,
which are needed to mirror messages to streams from other users for
the IRC and Jabber mirroring integrations (see

View File

@@ -6,7 +6,7 @@
recommend against installing with less than 2GB of RAM**, as you will
likely experience OOM issues. In the future we expect Zulip's RAM
requirements to decrease to support smaller installations (see
https://github.com/zulip/zulip/issues/32).
[https://github.com/zulip/zulip/issues/32](https://github.com/zulip/zulip/issues/32)).
* At least 10GB of free disk for production use (more may be required
if you intend to store uploaded files locally rather than in S3
and your team uses that feature extensively)
@@ -26,8 +26,8 @@ following [these
instructions](readme-symlink.html#installing-the-zulip-development-environment),
since then you don't need to worry about setting up SSL certificates
and an authentication mechanism. Or, you can check out the
[developers' chatroom (a public, running Zulip
instance)](http://zulip.tabbott.net/).
[developers' chatroom](http://zulip.tabbott.net/) (a public, running Zulip
instance).
For more details, see [full instructions for installing Zulip in
production](prod-install.html).

View File

@@ -10,8 +10,8 @@ Zulip community. From when Zulip was released as open source in late
September 2015 through today (mid-April, 2016), over 300 pull requests
have been submitted to the various Zulip repositories (and over 250
have been merged!), the vast majority of which are submitted by
Zulip's users around the world (as opposed to the small core team who
review and merge the pull requests).
Zulip's users around the world (as opposed to the small core team that
reviews and merges the pull requests).
In any project, there can be a lot of value in periodically putting
together a roadmap detailing the major areas where the project is
@@ -45,8 +45,8 @@ Without further ado, below is the Zulip 2016 roadmap.
The top problem for the Zulip project is the state of the mobile apps.
The Android app has started seeing rapid progress thanks to a series
of contributions by Lisa Neigut of Recurse Center, and we believe to
be on a good path. The iOS app has fewer features than Android and
of contributions by Lisa Neigut of Recurse Center, and we believe it
is on a good path. The iOS app has fewer features than Android and
has more bugs, but more importantly is in need of an experienced iOS
developer who has time to drive the project.
@@ -129,7 +129,7 @@ initial goal is working well with only 2GB of RAM).
## Performance
Performance is essential for a communication tool. While some things
are already quite good (E.g. narrowing and message sending is speedy),
are already quite good (e.g. narrowing and message sending is speedy),
this is an area where one can always improve. There are a few known
performance opportunities:
@@ -163,7 +163,7 @@ of its size, it takes work to keep it that way.
## Deployment and upgrade process
* <strike>[Support backwards-incompatible upgrades to Python libraries](https://github.com/zulip/zulip/issues/717)</strike>
* [Minimize the downtime required in Zulip upgrade process](https://github.com/zulip/zulip/issues/646)
* [Minimize the downtime required in the Zulip upgrade process](https://github.com/zulip/zulip/issues/646)
## Security
@@ -220,7 +220,8 @@ process and make bots that receive messages just as easy to build.
## Android app
The Zulip Android app is ahead of the iOS app in terms of feature set,
so this section serves to document the goals for Zulip on mobile.
but there is still a lot of work to do. Most of the things listed below
will eventually apply to the iOS app as well.
* <strike>[Support using a non-zulip.com server](https://github.com/zulip/zulip-android/issues/1)</strike>
* [Support Google authentication with a non-Zulip.com server](https://github.com/zulip/zulip-android/issues/49)
@@ -247,7 +248,7 @@ the app with more specific improvements.
## Desktop apps
The top goal for the desktop apps is to rebuild it in modern toolchain
The top goal for the desktop apps is to rebuild it in a modern toolchain
(probably Electron) so that it's easy for a wide range of developers
to contribute to the apps.