Commit Graph

1542 Commits

Author SHA1 Message Date
Tim Abbott
7042965102 docs: Remove Vagrant docs zulip-devel recommendation.
Nobody has actually gone to the email list in like 2 years, and we
just renamed it to be an announcement list.
2019-05-20 15:37:13 -07:00
Tim Abbott
e006a628b1 docs: Update THIRDPARTY notes on upstream.
Mostly copyright date updates, but also removing references to the
deprecated zulip-devel@googlegroups.com.
2019-05-20 15:29:05 -07:00
Tim Abbott
e4c3864772 docs: Further update architecture overview intro. 2019-05-20 11:48:34 -07:00
Tim Abbott
f140228528 docs: Update architecture overview introduction.
This doc needs significant further updates, but this at least makes
clear Zulip supports organizations well past 1000 users and adds some
links.
2019-05-20 11:35:47 -07:00
Steve Howell
6b39d6004e zjquery: Use Proxy to detect undefined stubs.
We now use a Proxy to wrap zjquery elements, so
that we can detect callers trying to invoke methods
(or access attributes) that do not exist.  We try
to give useful error messages in those cases.

The main impact here is that we force lots of tests
to explicitly stub `length`.

Also, we can't do equality checks on zjquery
objects any more due to the proxy object, but the
easy workaround is to compare selectors.  (This
is generally an unnecessary technique, anyway.)

The proxy wrapper is fairly straightforward, and
we just have a few special cases for things like
"inspect" that happen when you try to print out
objects.
2019-05-20 11:28:32 -07:00
Kanishk Kakar
77ab9a0eb0 docs: Update desktop repo URL. 2019-05-20 11:01:11 -07:00
Tim Abbott
119948022f docs: Improve discussion of GitHub area teams.
The content in that paragraph had been written when GSoC was mainly
zulip/zulip.
2019-05-19 16:19:47 -07:00
Rishi Gupta
d0dcee9b59 docs: Make minor edits to gsod-ideas.md. 2019-05-17 11:37:57 -07:00
Tim Abbott
71f84a3a8b docs: Link to Ksplice blog for more example posts.
This update is in response to feedback that we only had one example
post available.
2019-05-09 11:47:27 -07:00
Rishi Gupta
529d424bed docs: Add numbering to import section of export-and-import.md.
The numbers are in parens to avoid the markdown processor interpreting them
as numbers -- I couldn't get the automatic numbering to work out with the
paragraph breaks and so on, and this is probably good enough for now.
2019-05-06 22:16:17 -07:00
David Wood
f53a8f8bb6 settings: Rename create_stream_permission in templates.
This commit renames the `create_stream_permission` field in the
templates to `create_stream_policy`, matching the field used in the
database model. This matches what `invite_to_stream_policy` does and
will be clearer when the `waiting_period_threshold` is split into its
own field.
2019-05-06 16:30:01 -07:00
Mayank Madan
99414e2d96 provision: Add support for Debian 10 Buster. 2019-05-05 17:57:19 -07:00
Kouhei Sutou
a046a0957b docs: Fix upgrade process for Ubuntu 16.04 -> 18.04.
We need to disable "CREATE EXTENSION pgroonga" in zulip-puppet-apply
by creating /usr/share/postgresql/10/pgroonga_setup.sql.applied.
Because PostgreSQL 10 isn't running in this case. If PostgreSQL 10
isn't running, we can't run "CREATE EXTENSION pgroonga".

We can't use pg_upgrade with PGroonga. PGroonga's install SQL
https://github.com/pgroonga/pgroonga/blob/master/data/pgroonga.sql has
conditions to support multiple PostgreSQL versions. So it's not safe
to use pg_upgrade. pg_upgrade copies metadata for PostgreSQL 9.5 to
PostgreSQL 10. We need to use pg_dump and pg_restore to upgrade
PGroonga correctly for PostgreSQL 10.
2019-05-03 17:35:32 -07:00
Kouhei Sutou
407ed45ec2 docs: Use systemctl instead of service.
Because memcached package on Ubuntu 18.04 supports systemd.
2019-05-03 17:33:29 -07:00
Vishnu Ks
ed81906fc9 docs: Direct GSoD students to #documentation instead of #GSoC. 2019-04-30 14:52:53 -07:00
Tim Abbott
9ece4c9f51 docs: Add documentation for the delete and reimport process.
This is a common thing folks ask how to do.
2019-04-28 21:49:13 -07:00
Rishi Gupta
14428f7996 docs: Clarify you need to upgrade from git for Zulip Cloud exports. 2019-04-26 15:59:24 -07:00
Tim Abbott
c1d8b17e49 docs: Stop mentioning legacy Android app in gsoc ideas. 2019-04-25 15:40:09 -07:00
Rishi Gupta
6e2adc6a7b docs: Update gsod-ideas.md. 2019-04-25 15:38:52 -07:00
Tim Abbott
bf9f08a3e6 version: Update version and changelog for Zulip 2.0.3 release. 2019-04-23 16:05:12 -07:00
Anders Kaseorg
f772b5d7d4 docs: Fix easy HTML validation errors and warnings.
"file:/srv/zulip/docs/_build/html/git/troubleshooting.html":266.5-266.12: error: Element "commit" not allowed as child of element "em" in this context. (Suppressing further errors from this subtree.)
"file:/srv/zulip/docs/_build/html/git/troubleshooting.html":266.13-266.17: error: End tag "em" violates nesting rules.
"file:/srv/zulip/docs/_build/html/overview/architecture-overview.html":211.69-211.136: error: Start tag "a" seen but an element of the same type was already open.
"file:/srv/zulip/docs/_build/html/overview/architecture-overview.html":211.171-211.174: error: Stray end tag "a".
"file:/srv/zulip/docs/_build/html/translating/hindi.html":252.36-252.48: info warning: Text run is not in Unicode Normalization Form C.
"file:/srv/zulip/docs/_build/html/tutorials/writing-views.html":469.34-469.41: error: Element "method" not allowed as child of element "p" in this context. (Suppressing further errors from this subtree.)
"file:/srv/zulip/docs/_build/html/tutorials/writing-views.html":471.122-471.125: error: End tag "p" seen, but there were open elements.
"file:/srv/zulip/docs/_build/html/tutorials/writing-views.html":469.34-469.41: error: Unclosed element "method".

Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2019-04-23 12:56:05 -07:00
Tim Abbott
d4893dfcbc docs: Make API endpoint docs link to materials on REQ.
This should help avoid bugs like the one in the previous commit.
2019-04-23 11:31:19 -07:00
Tim Abbott
edd7a1ab53 docs: Add initial project ideas page for GSoD. 2019-04-19 14:50:06 -07:00
Tim Abbott
bf52ddc33a docs: Make sure that postgresql is running in OS upgrade instructions.
At least in the Trusty->Xenial upgrade flow, it can end up not running.
2019-04-17 12:58:42 -07:00
Tim Abbott
e566cad1da docs: Add OS upgrade step to remove upstart.
It's not required on Ubuntu Xenial (having been replaced by systemd)
and causes problems when installing/upgrading other packages; this
change matches a similar block of code in our installer.
2019-04-17 12:58:42 -07:00
Tim Abbott
18146ed947 script: Add static asset pipeline option to support OS upgrades.
The comment explains this in more detail, but basically one previously
needed the `--from-git` option to `upgrade-zulip-stage-2` if one had
last installed/upgraded from Git, and not that option otherwise, which
would have forced us to make the OS upgrade documentation much more
complicated than it needed to be.
2019-04-17 12:58:42 -07:00
Tim Abbott
6828cea76a docs: Clarify some key parts of OS upgrade documentation.
Thanks to Vishnu Ks for testing to figure these out.
2019-04-17 12:58:42 -07:00
Shubham Padia
31cedbc9b8 backup: Make --output an optional argument instead of a positional one.
Fixes #12150.
Previously the `output` argument was positional, while the docs described
the arguments as optional in the form of `--output=...`.
2019-04-17 12:14:11 -07:00
Shubham Padia
32cf192b9b backup: Add option --skip-uploads to skip uploads backup. 2019-04-17 12:14:11 -07:00
Shubham Padia
984d3f2f0e backup: Add option --skip-db to skip database backup.
This may be relevant for organizations that use a corporate remote
postgres server and just want to backup their configuration.
2019-04-17 12:14:11 -07:00
Tim Abbott
5d2984fb46 docs: Document upgrading the version of Ubuntu.
One longstanding gap in our production documentation is how to
properly do an upgrade to the operating system on which Zulip is
installed.

This adds that documentation.

Ideally, we'd get a few folks to test this procedure over the next few
days to make sure it's bulletproof.

Fixes #1705.
Fixes #10796.
2019-04-14 21:59:40 -07:00
YashRE42
6f5184bf01 docs: Explain stubbing for node tests. 2019-04-13 22:45:22 -07:00
ruchit2801
f71d8a7ed5 docs: remove repeated 'etc.' word from sending-messages.md.
There are two 'etc' words in the same line. This removes one of them.

Note from Tim: The old text was arguably correct, but removing it is definitely clearer.
2019-04-13 19:39:47 -07:00
Tim Abbott
a44de17f9b docs: Add initial documentation for TypeScript.
This is a draft/preliminary document on how we're doing our TypeScript
migration; I'm sure we'll add a lot more over the coming weeks.
2019-04-13 12:20:40 -07:00
Tim Abbott
858ac3cf3f docs: Clarify we're now fully on the Python 3 type syntax. 2019-04-13 11:55:33 -07:00
Marco Burstein
ae5496020b docs: Add ".ts" support in docs and configuration.
Add references to TypeScript in documentation where appropriate, such
as in example bash commands and discussions of the file structure.
Add a new section to the Reading List with TypeScript resources.
Also update `.editorconfig` to support ".ts" files.

Fix part of #12000.
2019-04-12 11:26:17 -07:00
Tim Abbott
0a656bec8a docs: Fix incorrect path to remote development nginx file. 2019-04-11 16:24:57 -07:00
Wyatt Hoodes
aac09b22ac vagrant: Add option to specify system settings.
Two variables were declared and assigned the respective values of the
default settings for the system. If the keyword is used in the
~/.zulip-vagrant-config file, the value is assigned to the variable.

There is no straightforward way to customize the virtual machine's
number of cpus or memory, this commit addresses that fact.
2019-04-11 12:28:12 -07:00
Tim Abbott
93b2fa9b7c docs: Improve documentation on node test suite.
The most important part of this is encouraging folks to read the
zjquery documentation.
2019-04-10 16:35:35 -07:00
Mohit Maroliya
e16d721921 docs: Fix a few typos in documentation. 2019-04-10 10:44:35 -07:00
Vaibhav
f852868673 docs: Add message box to manual testing docs.
This adds numerous manual testing methods and checks to the
`manual-testing.md` to verify the functioning of various hotkeys,
click handlers and appearance of the message box.
2019-04-07 13:01:24 -07:00
Sahil Batra
c2fa8765a7 docs: Fix typo in gsoc-ideas.md. 2019-04-06 13:23:08 -07:00
Tim Abbott
abc7a00d35 Revert "docs: Update .html links to .md."
This doesn't work without the CommonMark upgrade.

This reverts commit c87893feea.
2019-04-05 17:58:54 -07:00
Samuel Searles-Bryant
c87893feea docs: Update .html links to .md.
Sphinx/ReadTheDocs supports automatically translating links written as
to `.md` files to point to the corresponding `.html` files, so this
migration does not change the resulting HTML output in ReadTheDocs.
But it does fix apparent broken links on GitHub.

This doesn't prevent people from reading the documentation on GitHub
(so doesn't mitigate the fact that some rtd-specific syntax does not
render properly on GH), but it will prevent us from getting erroneous
issues reported about the hyperlinks not working.

Fixes: #11087.
2019-04-05 17:16:25 -07:00
ruchit2801
33b064aa29 documentation: Add missing link to upgrade-zulip-from-git. 2019-03-22 09:22:18 -07:00
Tim Abbott
0d04724da6 docs: Clarify push notification service privacy model.
This just makes what was already said there a lot more explicit.
2019-03-21 16:49:10 -07:00
Zach Wener-Fligner
ab15cd13a6 docs: Modify dev SSL/certbot setup docs to match script.
The docs specify passing hostname with the --hostname flag, which
doesn't match the actual usage in scripts/setup/setup-certbot. This
change fixes the docs to match the actual usage.
2019-03-19 10:45:53 -07:00
Tim Abbott
4f628fd945 docs: Discuss replacing memcached with redis more clearly.
This is a common question we get in architecture discussions.
2019-03-18 12:40:53 -07:00
Ben Muschol
d526ff00f2 settings: Rename "user avatar" to "profile picture"
This renames references to user avatars, bot avatars, or organization
icons to profile pictures. The string in the UI are updated,
in addition to the help files, comments, and documentation. Actual
variable/function names, changelog entries, routes, and s3 buckets are
left as-is in order to avoid introducing bugs.

Fixes #11824.
2019-03-15 13:29:56 -07:00
Tim Abbott
cfbe316215 version: Update version and changelog for Zulip 2.0.2 release. 2019-03-15 12:25:50 -07:00