Tim Abbott
196d5b8c59
docs: Add a few introductory paragraphs to our code style doc.
2020-05-19 14:22:15 -07:00
Tim Abbott
ccd306d3f4
docs: Improve code style commentary on testing.
2020-05-19 14:11:53 -07:00
Alex Vandiver
031260573f
docs: Link to section on migrating local -> S3 storage.
...
This section at the top was clearly written before the documentation
at the bottom existed, and hasn't been updated to point to the
now-existent docs below.
Add the link, rather than directing to #production-help.
2020-05-19 14:08:44 -07:00
Alex Vandiver
fb3f6bb68e
docs: Reword `zulip_path` suggestion.
...
"declare the path with `zulip_path`" is opaque; be more explicit about
what should be done.
2020-05-19 14:07:12 -07:00
Alex Vandiver
310487c868
docs: Reformat timezone advice into bullet form.
2020-05-19 14:07:12 -07:00
Alex Vandiver
001334ed2d
docs: Provide "right" example of using ids in sets.
2020-05-19 14:05:20 -07:00
Alex Vandiver
d17baaf2af
docs: Stop suggesting get_stream, which is anti-suggested.
...
Use of `get_stream` itself is explicitly suggested against by a
linter, in preference to the `access_stream_by_` methods; suggest
those here instead.
2020-05-19 14:05:20 -07:00
Alex Vandiver
9800392beb
docs: Be more explicit about good prefetching patterns.
...
The problem is not the list comprehension, as the previous wording
implied, but rather the fact that data is needed from the linked
table.
Be explicit about _what_ in the QuerySet API is helpful for addressing
this -- namely, use of `select_related`.
2020-05-19 14:05:20 -07:00
Tim Abbott
9b9aa23f6a
docs: Fix path for API code markdown extension.
2020-05-19 11:11:41 -07:00
Steve Howell
ca0b8fd4b3
docs: Downplay actions.py a bit.
2020-05-17 21:32:38 -07:00
Steve Howell
2da81d9ab5
docs: Explain we don't use nginx in dev.
2020-05-17 21:29:28 -07:00
Steve Howell
c8ce12bdd0
docs: Add missing comma.
2020-05-17 21:27:31 -07:00
Steve Howell
c4208bf39b
docs: Use modern stream narrow urls.
2020-05-17 21:27:31 -07:00
Steve Howell
86c3ba26ff
docs: Update tornado line count.
2020-05-17 21:27:30 -07:00
Steve Howell
3cda5b61b1
docs: List four types of emojis.
2020-05-17 21:26:56 -07:00
Steve Howell
792e28056e
docs: Use 5 seconds as our bar for null provisions.
2020-05-17 21:25:53 -07:00
Steve Howell
c1dc7b99ea
docs: Put backticks around `SourceMap`.
2020-05-17 21:25:53 -07:00
Steve Howell
cdeeffb44b
docs: Replace "fancy" with longstanding.
2020-05-17 21:25:53 -07:00
Steve Howell
6c4a471cc2
docs: Word cautioning advice more directly.
2020-05-17 21:25:53 -07:00
Steve Howell
23c2198da3
docs: Use string_id in header.
2020-05-17 21:25:53 -07:00
Steve Howell
35df5f35d8
docs: Keep manual-restore steps sequential.
2020-05-17 21:25:53 -07:00
Steve Howell
0267e5b145
docs: Mention zilencer in context.
...
We mention zilencer later in the docs, but I think it's
important to mention it specifically in the context of
management commands, too.
2020-05-17 21:25:53 -07:00
Steve Howell
f8606eb68a
docs: Alphabetize glossary.
2020-05-17 21:25:53 -07:00
Steve Howell
0b3d14a408
docs: Remove alpha status for ZulipTerminal.
2020-05-17 07:56:38 -04:00
Steve Howell
b3c9676baf
docs: Use full path for zulip.yaml.
...
Note that this section may actually be obsolete.
2020-05-17 07:56:38 -04:00
Steve Howell
cc9e6a54c0
doc: Fix tense for "Include".
2020-05-17 07:56:38 -04:00
Puneeth Chaganti
614d4a3da8
docs: Add note about generating integrations bot avatar image.
2020-05-11 14:49:11 -07:00
Anders Kaseorg
8cdf2801f7
python: Convert more variable type annotations to Python 3.6 style.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-05-08 16:42:43 -07:00
Alex Vandiver
3a7a032ee2
docs: Remove unnecessary double-backticks in indented line.
...
These came in during the conversion from rST in 337155f280
.
2020-05-05 21:28:00 -07:00
Tim Abbott
1c1c47b94a
docs: Delete discussion of legacy push notifications signup.
...
This hasn't been used in months; it was only there in case of problems
with the rollout of the automated workflow, so it makes sense to
delete it now.
2020-05-05 15:59:35 -07:00
Vishnu Ks
9a8d0ca9fe
docs: Recommend contact page over email wherever possible.
...
With a few tweaks from tabbott to preserve the enthusiasm for feedback
and de-emphasize twitter as a channel (we give better support
elsewhere).
2020-05-05 15:57:54 -07:00
Anders Kaseorg
b094534319
THIRDPARTY: Add missing license texts for CC-BY-3.0, CC-BY-SA-4.0.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-05-02 10:07:55 -07:00
Anders Kaseorg
587ab554f7
THIRDPARTY: Use standard CC0 short name.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-05-02 10:07:55 -07:00
Anders Kaseorg
dbee6b5622
THIRDPARTY: Fix short name references for Apache-2.0, BSD-2-Clause.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-05-02 10:07:55 -07:00
Anders Kaseorg
e11f709054
THIRDPARTY: Update Format URL to https.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-05-02 10:07:55 -07:00
arpit551
a6df0b94dd
doc: Updated docs for the job xenial-legacy.
2020-04-28 11:28:07 -07:00
Tim Abbott
28cb0aa81a
docs: Use consistent spelling of CircleCI.
2020-04-28 11:26:58 -07:00
arpit551
16d41e59b5
doc: Update documentation replacing travis with CircleCI.
2020-04-28 11:24:54 -07:00
Tim Abbott
9566905b81
docs: Clarify nginx reverse proxy documentation.
...
Fixes #14740 .
2020-04-26 10:51:39 -07:00
Anders Kaseorg
257a026f13
docs: Bump copyright year.
...
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-23 16:04:54 -07:00
Rohitt Vashishtha
2825e6ad48
i18n: Support subexpressions of type (t "text") in Handlebars.
2020-04-22 17:57:16 -07:00
Anders Kaseorg
fead14951c
python: Convert assignment type annotations to Python 3.6 style.
...
This commit was split by tabbott; this piece covers the vast majority
of files in Zulip, but excludes scripts/, tools/, and puppet/ to help
ensure we at least show the right error messages for Xenial systems.
We can likely further refine the remaining pieces with some testing.
Generated by com2ann, with whitespace fixes and various manual fixes
for runtime issues:
- invoiced_through: Optional[LicenseLedger] = models.ForeignKey(
+ invoiced_through: Optional["LicenseLedger"] = models.ForeignKey(
-_apns_client: Optional[APNsClient] = None
+_apns_client: Optional["APNsClient"] = None
- notifications_stream: Optional[Stream] = models.ForeignKey('Stream', related_name='+', null=True, blank=True, on_delete=CASCADE)
- signup_notifications_stream: Optional[Stream] = models.ForeignKey('Stream', related_name='+', null=True, blank=True, on_delete=CASCADE)
+ notifications_stream: Optional["Stream"] = models.ForeignKey('Stream', related_name='+', null=True, blank=True, on_delete=CASCADE)
+ signup_notifications_stream: Optional["Stream"] = models.ForeignKey('Stream', related_name='+', null=True, blank=True, on_delete=CASCADE)
- author: Optional[UserProfile] = models.ForeignKey('UserProfile', blank=True, null=True, on_delete=CASCADE)
+ author: Optional["UserProfile"] = models.ForeignKey('UserProfile', blank=True, null=True, on_delete=CASCADE)
- bot_owner: Optional[UserProfile] = models.ForeignKey('self', null=True, on_delete=models.SET_NULL)
+ bot_owner: Optional["UserProfile"] = models.ForeignKey('self', null=True, on_delete=models.SET_NULL)
- default_sending_stream: Optional[Stream] = models.ForeignKey('zerver.Stream', null=True, related_name='+', on_delete=CASCADE)
- default_events_register_stream: Optional[Stream] = models.ForeignKey('zerver.Stream', null=True, related_name='+', on_delete=CASCADE)
+ default_sending_stream: Optional["Stream"] = models.ForeignKey('zerver.Stream', null=True, related_name='+', on_delete=CASCADE)
+ default_events_register_stream: Optional["Stream"] = models.ForeignKey('zerver.Stream', null=True, related_name='+', on_delete=CASCADE)
-descriptors_by_handler_id: Dict[int, ClientDescriptor] = {}
+descriptors_by_handler_id: Dict[int, "ClientDescriptor"] = {}
-worker_classes: Dict[str, Type[QueueProcessingWorker]] = {}
-queues: Dict[str, Dict[str, Type[QueueProcessingWorker]]] = {}
+worker_classes: Dict[str, Type["QueueProcessingWorker"]] = {}
+queues: Dict[str, Dict[str, Type["QueueProcessingWorker"]]] = {}
-AUTH_LDAP_REVERSE_EMAIL_SEARCH: Optional[LDAPSearch] = None
+AUTH_LDAP_REVERSE_EMAIL_SEARCH: Optional["LDAPSearch"] = None
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-22 11:02:32 -07:00
Anders Kaseorg
f8c95cda51
mypy: Add specific codes to type: ignore annotations.
...
https://mypy.readthedocs.io/en/stable/error_codes.html
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-22 10:46:33 -07:00
Steve Howell
54151bb548
db tools: Rename do-destroy-*database.
...
The new tools now have more concise, more parallel names:
- rebuild-dev-database
- rebuild-test-database
The actual implementations are still pretty different:
rebuild-dev-database:
mostly delegates to 5 management scripts
rebuild-test-database:
is a very thin wrapper for generate-fixtures
We'll try to clean that up a bit soon.
2020-04-22 09:24:42 -07:00
Aman Agrawal
59c2b6dcc7
release-checklist: Replace Xenial with Focal.
2020-04-21 15:03:14 -07:00
Aman Agrawal
79acd5ae40
docs: Remove development Xenial and Stretch support.
2020-04-21 15:01:31 -07:00
Aman Agrawal
c87d58bb4f
docs/wsl: Add recommendations for developing using wsl.
2020-04-20 23:21:45 -07:00
Aman Agrawal
b13beb5ea8
circleci: Remove Xenial build as we are deprecating Xenial.
...
Docs updated to reflect the change.
2020-04-19 11:38:49 -07:00
Anders Kaseorg
f506b05667
docs: Remove obsolete claims about Blueslip wrapping things.
...
These are obsolete since e0a18d3394
(#12737 ).
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-18 22:37:37 -07:00
Ray Kraesig
8b72de1d4d
version control: Add note about paragraph formatting.
...
We've been getting a number of submissions lately that haven't used
blank lines in between paragraphs, so add that to our style guide.
2020-04-18 13:37:33 -07:00