Anders Kaseorg
a6e01b35fc
docs: Fix `pip compile` typo.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-09-08 12:06:24 -07:00
Anders Kaseorg
f4d2d199e2
docs: Display `main` branch name as inline code.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-09-06 12:56:35 -07:00
Anders Kaseorg
646c04eff2
Rename default branch to ‘main’.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-09-06 12:56:35 -07:00
Anders Kaseorg
1ce12191aa
docs: Update links for other repository branch renames.
...
GitHub redirects these, but we should use the canonical URLs.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-08-31 15:28:01 -07:00
Alex Vandiver
7d7d727865
tools: Switch to download.zulip.com from www.zulip.org.
2021-08-26 17:21:31 -07:00
Alex Vandiver
710a92f48c
tools: Add a tool to upload release tarballs to S3.
2021-08-26 17:21:31 -07:00
Anders Kaseorg
7b3d4ff1de
docs: Escape asterisks for Prettier compatibility.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-08-20 23:14:37 -07:00
Anders Kaseorg
b53e676860
docs: Convert reST index pages to Markdown.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-08-20 06:22:42 -07:00
Anders Kaseorg
b29b6f6526
docs: Add syntax highlighting languages to code blocks.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-08-20 06:14:47 -07:00
Anders Kaseorg
672358c5da
docs: Migrate from recommonmark to MyST-Parser.
...
Recommonmark is no longer maintained, and MyST-Parser is much more
complete.
https://myst-parser.readthedocs.io/
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-08-19 00:53:32 -07:00
Tim Abbott
e4667c2af6
docs: Add developer documentation for Python support.
2021-07-28 11:23:27 -07:00
PIG208
c7210bfc75
docs: Update client.md for the request notes change.
...
`request.client` is no longer valid since the ZulipRequestNotes change.
This update the documentation to reflect that. And it also makes it
recommend `check_send_webhook_message` in favor of
`check_send_stream_message`.
2021-07-26 08:40:53 -07:00
Tim Abbott
454a900487
docs: Replace chat-zulip-org page with /developer-community/.
2021-07-25 22:17:57 -07:00
Tim Abbott
1905bb8f1a
docs: Document forked change password command.
2021-07-09 12:37:55 -07:00
Steve Howell
8ffe22fc15
slash commands: Remove /settings command.
...
It's easy enough for power keyboard users to just use "g"
to get to settings, and it's certainly easier for
mouse users to just go to the menu.
2021-07-08 10:47:52 -04:00
Anders Kaseorg
0ae94c6051
mypy: Move configuration to pyproject.toml.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-07-05 17:01:32 -07:00
Abhijeet Prasad Bodas
6bbfddb6c3
docs: Split widgets and slash command developer pages.
2021-07-01 08:06:46 -04:00
PIG208
a254fa24ee
docs: Use `JsonableError` instead of `json_error`.
2021-06-30 16:26:54 -07:00
Steve Howell
dcb058ca8b
docs: Remove BETA label for widget docs.
2021-06-28 21:59:22 -07:00
Anders Kaseorg
0ba9114c22
install-yarn: Rewrite Yarn installer.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-06-27 16:58:17 -07:00
Abhijeet Prasad Bodas
678526881b
docs: Update developer documentation for notification_data.py.
...
We extracted a bunch of code into the common notification_data.py
module, with a data class managing a lot of the logic; this updates
the documentation to cover that.
2021-06-25 08:57:56 -07:00
Tim Abbott
054be8dd2e
docs: Document new copied Django function.
2021-06-17 11:32:43 -07:00
Anders Kaseorg
e0769e39da
docs: Document how ShellCheck and shfmt are installed.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-06-09 11:01:42 -07:00
Tim Abbott
bb83aab860
docs: Correct widgets doc discussion of slash commands.
2021-06-04 09:23:51 -07:00
Abhijeet Prasad Bodas
e11648f22e
docs: Fix typo in subsystems/notifications.md.
2021-06-01 15:26:49 -07:00
Alex Vandiver
87a109e3e0
puppet: Pull in pinned puppet modules.
...
Using puppet modules from the puppet forge judiciously will allow us
to simplify the configuration somewhat; this specifically pulls in the
stdlib module, which we were already using parts of.
2021-05-27 21:14:48 -07:00
Tim Abbott
0294ce76b4
docs: Mention TODO/compatibility comments for events migrations.
2021-05-26 15:21:48 -07:00
Abhijeet Prasad Bodas
ddd123f133
message send: Rename `push_notify_user_ids` -> `online_push_user_ids`.
...
The old name `push_notify_user_ids` was misleading, because
it does not contain user ids which should be notified for
the current message, but rather user ids who have the online
push notifications setting enabled.
When the Tornado server is restarted during an upgrade, if
server has old events with the `push_notify_user_ids` fields,
the server will throw error after this rename. Hence, we need
to explicitly handle such cases while processing the event.
2021-05-26 15:13:08 -07:00
Tim Abbott
47689feb33
docs: Extend documentation on Tornado schema changes.
2021-05-24 13:56:58 -07:00
Anders Kaseorg
e015f3ed7d
docs: Correct “webapp” to “web app”.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-05-14 13:15:38 -07:00
Tim Abbott
7486b646d8
docs: Update missing details in release checklist.
2021-05-13 12:36:56 -07:00
Alex Vandiver
0f1611286d
management: Rename the deliver_email command to deliver_scheduled_email.
...
This makes it parallel with deliver_scheduled_messages, and clarifies
that it is not used for simply sending outgoing emails (e.g. the
`email_senders` queue).
This also renames the supervisor job to match.
2021-05-11 13:07:29 -07:00
Anders Kaseorg
544bbd5398
docs: Fix capitalization mistakes.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-05-10 09:57:26 -07:00
Tim Abbott
129b5c6779
docs: Document our choice of tooltip library.
...
This page has very little documentation on UI widgets in general, but
adding this is probably net helpful.
Fixes #1398 .
2021-05-09 21:54:51 -07:00
Mateusz Mandera
8bc614abf6
docs: Mention quirk of mixing ALTER TABLE and RunPython in migrations.
2021-05-09 09:38:08 -07:00
Mateusz Mandera
ddcb919e4d
docs: Mention new AddIndexConcurrently operation in migration doc.
2021-05-09 09:37:28 -07:00
Anders Kaseorg
405bc8dabf
requirements: Remove Thumbor.
...
Thumbor and tc-aws have been dragging their feet on Python 3 support
for years, and even the alphas and unofficial forks we’ve been running
don’t seem to be maintained anymore. Depending on these projects is
no longer viable for us.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-05-06 20:07:32 -07:00
Alex Vandiver
0663094920
docs: Document Sentry in logging docs.
2021-05-05 23:04:12 -07:00
Alex Vandiver
b26ef55d38
Remove old "conversion" documentation.
2021-05-05 23:03:26 -07:00
Alex Vandiver
bf1a6d18ef
docs: Remove out-of-date "users" documentation.
2021-05-05 23:03:26 -07:00
Alex Vandiver
045e8aa2f0
docs: Remove old "custom apps" documentation.
...
This is significantly out of date; https://chat.zulip.org/api/ serves
as documentation of the current state of affairs.
2021-05-05 23:03:26 -07:00
Tim Abbott
07a2e91688
docs: Update changelog heading for new release lifecycle page.
...
Also update the release checklist to make sure we don't forget to
update the top-heading section when we publish a new major release.
2021-05-05 17:45:11 -07:00
Abhijeet Prasad Bodas
80ccfc79df
docs: Fix outdated pre-ES6 function examples.
2021-05-05 09:34:39 -07:00
Mateusz Mandera
537186f474
docs: Remove mention of SessionMiddleware from django-upgrades.md.
...
We no longer fork SessionMiddleware since
dce6b4a40f
.
2021-05-02 13:15:38 +02:00
Tim Abbott
03e155f38a
docs: Add production documentation for custom management commands.
2021-04-29 12:36:13 -07:00
Alex Vandiver
bc9d20eaa2
docs: Describe the process of upgrading settings.py files.
...
Fixes #17782 .
2021-04-27 18:01:28 -07:00
Anders Kaseorg
6060d0d364
docs: Add missing space to compound verbs “log in”, “set up”, etc.
...
Noun: backup, checkout, cleanup, login, logout, setup, shutdown, signup,
timeout.
Verb: back up, check out, clean up, log in, log out, set up, shut
down, sign up, time out.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-04-26 09:31:08 -07:00
Anders Kaseorg
e3f2ffa681
docs: Capitalize “Markdown” consistently.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-04-26 09:31:08 -07:00
Anders Kaseorg
178736c8eb
docs: Fix spelling errors caught by codespell.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-04-26 09:31:08 -07:00
Mateusz Mandera
977a2f7fa0
emails: Rename "missed message email" to "message notification email".
2021-04-21 10:10:54 -07:00
Riken Shah
14b01343d9
webpack: Introduce `webpack.dev-asset.json`.
...
This commit will now allow development-only pages to
use development-only packages without breaking the
production build.
2021-04-19 10:31:39 -07:00
Tim Abbott
4b3ac8c5ed
docs: Document TODO/compatability convention in release checklist.
...
This should provide a better mechanism for us to keep track of what
backwards-compatibility code we can safely delete.
2021-04-16 10:02:30 -07:00
Anders Kaseorg
9cae3450ff
docs: Update documentation for FormatJS migration.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-04-13 17:41:10 -07:00
Tim Abbott
ec8ffb8c80
docs: Fix typo in performance documentation.
2021-04-13 10:37:52 -07:00
Tim Abbott
1470dd9105
api: Delete ancient fetch_google_client_id endpoint.
...
This was used by the old native Zulip Android app
(zulip/zulip-android). That app has been undeveloped for enough years
that we believe it no longer functions; as a result, there's no reason
to keep a prototype API endpoint for it (that we believe never worked).
2021-04-08 06:10:39 -07:00
Tim Abbott
d690640e65
docs: Clarify how dev-secrets.conf works more.
2021-04-06 21:18:46 -07:00
Anders Kaseorg
738532ba51
requirements: Remove django-webpack-loader.
...
It does not seem like an official version supporting Webpack 4 (to say
nothing of 5) will be released any time soon, and we can reimplement
it in very little code.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-04-06 09:31:35 -07:00
Anders Kaseorg
8798b0a134
docs: Update documentation on JavaScript modules.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-03-29 14:53:33 -07:00
Tim Abbott
c5ff7daf52
docs: Add a few notes to release checklist.
2021-03-29 00:10:26 -07:00
Tim Abbott
9b19227862
docs: Update link to linkifiers in Help Center.
2021-03-28 19:23:35 -07:00
Vishnu KS
79586cc466
github: Create action for generating DigitalOcean one click app image.
2021-03-26 16:01:18 -07:00
Steve Howell
746cc9e1f6
refactor: Extract browser_history module.
...
This mainly extracts a new module called
browser_history. It has much fewer dependencies
than hashchange.js, so any modules that just
need the smaller API from browser_history now
have fewer transitive dependencies.
Here are some details:
* Move is_overlay_hash to hash_util.
* Rename hashchange.update_browser_history to
brower_history.update
* Move go_to_location verbatim.
* Remove unused argument for exit_overlay.
* Introduce helper functions:
* old_hash()
* set_hash_before_overlay()
* save_old_hash()
We now have 100% line coverage on the extracted
code.
2021-03-22 13:29:32 -07:00
Steve Howell
dbf19fe8d7
refactor: Extract watchdog module.
...
We now have 100% code coverage on this somewhat
fiddly code.
We also break activity's dependency on server_events.
2021-03-22 13:17:37 -07:00
Anders Kaseorg
3ef6f6e2e2
js: Convert static/js/blueslip.js to ES6 module.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-03-17 08:47:15 -04:00
Tim Abbott
a556abbec6
docs: Update path for in-app markdown help.
2021-03-11 21:28:51 -08:00
Sourabh
8d3f3952cd
doc: Path not provided for "check_message" and "do_send_message".
...
In the documentation of the "Sending messages," path for the `check_message` and `do_send_message` function is not provided. So, I added the path of both for future contributors.
2021-03-10 11:47:54 -08:00
Tim Abbott
b15cb27fcc
docs: Add a document explaining email/push notifications.
...
With various fixes by Mateusz Mandera.
2021-03-05 15:24:25 -08:00
Mateusz Mandera
6c7eee0a1f
presence: Document that a user can disable their presence updates.
...
This is a crucial detail, as it makes UserPresence an unreliable
indicator of when users were recently active. It should be documented
more clearly.
2021-03-01 15:05:17 -08:00
Aman Agrawal
39d123e355
recent_topics: Make it the default view.
...
Go to Recent Topics on "#", no hash and "#recent_topics".
Go to Recent Topics as the last destination for escape key.
Map `a` key to All messages and change its hash to
`#all_messages`.
2021-02-25 17:31:32 -08:00
Mateusz Mandera
138d67e852
docs: Writing tweaks to performance.md.
2021-02-17 14:29:31 -08:00
Steve Howell
06d9497a40
docs: Add minor tweaks to performance doc.
2021-02-16 17:10:17 -08:00
Alex Vandiver
422fea8f20
docs: Minor edits to scalability article.
2021-02-16 15:33:06 -08:00
Tim Abbott
912c6ab905
docs: Add table to scalability article.
...
This table can hopefully replace some of the prose discussion about
relative scalability impact (though I don't do that editing in this
commit).
2021-02-16 12:56:31 -08:00
Tim Abbott
150a07cdcd
docs: Add a performance design document.
...
This document is mainly an answer to a set of questions other
developers have been asking about Zulip's architecture and scalability
design. It's intended for developers working on Zulip, to help with
thinking about where to prioritize further efforts to optimize
scalability.
2021-02-13 13:05:47 -08:00
marchantia
56bf5f2a50
docs: Fix typo in 'caching in zulip'.
...
Change 'These days are fetched in' to 'This data is fetched in'.
2021-02-04 21:00:13 -05:00
Anders Kaseorg
4c09a549c9
release-checklist: Push dev tags to zulip-internal.git too.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-03 10:07:47 -08:00
Ganesh Pawar
bc6c83c12e
docs: Remove duplicate entry of file in widgets documentation.
2021-01-30 09:01:13 -08:00
Vishnu KS
7d8ade3b2a
dev_settings: Allow setting the value of EMAIL_USE_TLS from dev-secrets.
2021-01-29 14:51:38 -08:00
Tim Abbott
1636b893dc
docs: Add additional clarifications around realm terminology.
2021-01-21 16:31:03 -08:00
Steve Howell
09ff0c400d
tools: Rename tool to check-schemas.
2021-01-20 13:17:32 -08:00
marchantia
f03e4b9f04
docs: Fix typo in emoji.md.
...
Change emoji-map.json to emoji_map.json.
2021-01-12 10:20:35 -08:00
Tim Abbott
47d513240c
run-dev: Clean up unnecessary memcached output, and document flush.
2020-12-20 12:11:16 -08:00
YashRE42
967efc32d2
widgets: Remove tictactoe example widget.
...
Steve asked me to remove this, since the tictactoe game was always
intended as a proof of concept. Now that we have poll and todo
widgets, the sample code for tictactoe has much less value.
We replace the content and type in test_widgets.py to maintain
coverage.
2020-11-03 14:46:39 -08:00
Tim Abbott
cba7425cdc
docs: Clean up email testing docs a bit more.
2020-10-30 12:15:27 -07:00
Tim Abbott
f2b9109be5
docs: Tweak email testing notes a bit more.
2020-10-30 12:08:36 -07:00
Vishnu KS
ebe92fe70a
docs: Simplify email testing notes section.
...
No good reason for one note to be bold compared to
other notes.
2020-10-30 11:50:30 -07:00
Vishnu KS
7a6285ede7
email testing: Store the SMTP settings in dev-secrets.
...
It's super annoying to set this up each time I have to test
email templates in gmail.
2020-10-30 11:50:30 -07:00
Tim Abbott
067cd3a97a
docs: Remove incorrect references to chat.zulip.org.
...
Most of these are Help Center links that should be pointing to the
production Help Center.
2020-10-29 16:46:40 -07:00
Alex Vandiver
1f7132f50d
docs: Standardize on PostgreSQL, not Postgres.
2020-10-28 11:55:16 -07:00
Alex Vandiver
4cca1a2076
docs: Reword pgroonga sections.
...
These were somewhat stilted as originally written; reword.
2020-10-27 11:27:20 -07:00
Anders Kaseorg
72d6ff3c3b
docs: Fix more capitalization issues.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-10-23 11:46:55 -07:00
Alex Vandiver
25e995b677
puppet: Move normal_queues to the one place that uses it.
2020-10-22 11:32:25 -07:00
areebbeigh
b217cce80f
docs: Fix various typos.
...
This commit fixes typos in:
tutorials/new-feature-tutorial.md
subsystems/sending-messages.md
2020-10-15 14:39:43 -07:00
Areeb Beigh (Euphinx)
5d6f3eef29
docs: Fix typos in events-system.md.
...
Fixes 2 typos in events-system.md:
it's handler -> its handler
Event Queue Server server -> Event Queue Server
2020-10-12 12:10:50 -07:00
Tim Abbott
0c2d1f068d
docs: Extend documentation of event system testing.
2020-09-28 12:37:54 -07:00
Steve Howell
3e23c3b52c
event system docs: Explain how to write event tests.
...
In this commit I attempt to make the docs for
writing `test_events` a little more oriented
toward telling the developer that they need to
write a test in `test_events`; in other words,
the tone is a bit more of how-to-do-it vs.
explaining the innards.
So I now start with a concrete example.
Then much of the copy related to `verify_action`
is the same as before this commit, but I rework
it a bit to be a bit more step-by-step, and I refer
back to the concrete example.
Finally, I explain the schema checking step, which
is all new copy, although for that, I mostly
instruct the developer to read event_schema.py
itself.
2020-09-28 12:19:28 -07:00
Anders Kaseorg
fe66aef0ad
blueslip: Replace fatal with throw new Error(…).
...
This makes it clear to humans and ESLint that execution will not
continue.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-09-25 15:17:36 -07:00
Alex Vandiver
29459ea61f
release: Group and indent changes for major releases.
2020-09-21 21:03:29 -07:00
Alex Vandiver
173ee2177b
docs: Mention pulling release notes back over.
2020-09-17 17:16:06 -07:00
Anders Kaseorg
144296f9c0
release-checklist: Restore and clarify -dev version/tag for master.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-09-17 13:04:12 -07:00