544bbd5398
docs: Fix capitalization mistakes.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-05-10 09:57:26 -07:00
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
eee430e795
docs: Delete gsod-ideas.md.
...
This page is documentation for our participation in GSoD, which was a
few years ago. We can resurrect it if we participate in the program
again, so there's no need to keep it as a live page.
2021-05-04 15:21:49 -07:00
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
e3f2ffa681
docs: Capitalize “Markdown” consistently.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-04-26 09:31:08 -07:00
178736c8eb
docs: Fix spelling errors caught by codespell.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-04-26 09:31:08 -07:00
5fef101189
docs: Document zulip-archive GSoC idea.
2021-03-23 15:03:48 -07:00
a025726b62
docs: Remove reference to old length of GSoC projects.
2021-03-16 15:40:41 -07:00
2b23609f9a
ci: Remove unused circleci config file and update codebase.
...
We have disabled CircleCI and are using GitHub Actions for automated
testing.
docs: Changed context from CircleCI to Github Actions and wrote
some documentation specific to GH Actions.
tools: Replaced env checks for CIRCLECI with GITHUB_ACTION.
README: Use GitHub Actions build status badge.
2021-03-16 15:11:21 -07:00
42379a8cd1
docs: Reformat review feedback section.
...
This mostly preserves the general shape of the text, but adds a bit of
a bulleted checklist to help make it more skimmable.
2021-03-14 19:20:05 -07:00
ed3a230374
docs: Add guidlines for responding to a review feedback.
2021-03-06 05:45:35 -05:00
77194de136
docs: Correct typos in GSoC ideas doc.
2021-02-23 20:51:59 -08:00
94d6dd5ee5
docs: Update author protocol section of the code-reviewing docs.
2021-02-20 09:17:53 -05:00
e865e3156d
docs: Update GSoC ideas list.
...
This list is by no means final, but it has substantial updates from
last year's list.
2021-02-18 17:43:17 -08:00
38c3e3d855
docs: Move GSoC ideas to contributing/, and index.
...
This better fits the organization of our files; I would have fixed
this last year, but it's not easy to update the links from Google's
site.
2021-02-18 16:01:16 -08:00
6206d0486a
docs: Document official private streams.
...
These aren't relevant to most users, but in the interest of
transparency, we also don't want the existence of these to feel like a
secret. And maybe publishing their existence will result in folks who
we forget to add to these private streams asking about them.
2021-02-18 10:18:39 -08:00
a0d0b89adb
docs: Document Black and isort.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 15:31:59 -08:00
70c813e690
docs: Warn about the 'partially fixes' GitHub bug.
2020-12-18 12:49:16 -08:00
992c6126a8
docs: Update many references to Casper.
2020-08-30 17:16:02 -07:00
b4c2ae9cae
settings: Adjust documentation and comment references to settings.py.
...
`zproject/settings.py` itself is mostly-empty now. Adjust the
references which should now point to `zproject/computed_settings.py`
or `zproject/default_settings.py`.
2020-08-24 13:13:16 -07:00
c155403884
docs: Fix various capitalization errors.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-08-11 10:25:52 -07:00
768f9f93cd
docs: Capitalize Markdown consistently.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-08-11 10:23:06 -07:00
c6ed5c81de
styles: Format CSS with Prettier.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-08-04 16:34:19 -07:00
ab6ed22bff
docs: Document that we use Prettier.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-07-22 15:49:48 -07:00
0578a918e6
refactor: Rename test_bugdown.py to test_markdown.py.
...
Rename the file and all the refrences to file and module test_bugdown.py
to test_markdown.py.
This commit is part of series of commit that renames bugdown to markdown.
2020-06-26 17:08:37 -07:00
7b8ba5ebd9
docs: Update most remaining references to zulipchat.com.
...
In some cases, the cleanest tweak is to replace references to the
domain with Zulip Cloud, the product.
2020-06-08 18:10:45 -07:00
71078adc50
docs: Update URLs to use https://zulip.com .
...
We're migrating to using the cleaner zulip.com domain, which involves
changing all of our links from ReadTheDocs and other places to point
to the cleaner URL.
2020-06-08 18:10:45 -07:00
17afd460bc
docs: Fix typos in contributing/code-style.md.
2020-06-08 11:13:32 -07:00
1f565a9f41
timezone: Use standard library datetime.timezone.utc consistently.
...
datetime.timezone is available in Python ≥ 3.2. This also lets us
remove a pytz dependency from the PostgreSQL scripts.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-06-05 09:34:17 -07:00
196d5b8c59
docs: Add a few introductory paragraphs to our code style doc.
2020-05-19 14:22:15 -07:00
ccd306d3f4
docs: Improve code style commentary on testing.
2020-05-19 14:11:53 -07:00
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
310487c868
docs: Reformat timezone advice into bullet form.
2020-05-19 14:07:12 -07:00
001334ed2d
docs: Provide "right" example of using ids in sets.
2020-05-19 14:05:20 -07:00
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
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
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
28cb0aa81a
docs: Use consistent spelling of CircleCI.
2020-04-28 11:26:58 -07:00
16d41e59b5
doc: Update documentation replacing travis with CircleCI.
2020-04-28 11:24:54 -07:00
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
7ff9b22500
docs: Convert many http URLs to https.
...
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-26 21:35:32 -07:00
c220b971ae
docs: Fix some typos in documentation (most of them found and fixed by codespell).
...
Signed-off-by: Stefan Weil <sw@weilnetz.de>
2020-03-17 05:57:10 -07:00
59b047c862
docs: Tweak commit message guidelines.
...
- I fixed a typo with "lowerecase"
- I elaborated on the prefix before elaborating
on the rest of the message (i.e. went in correct
order).
- I split out the provision example (since we
talk about it some depth).
- I added more positive examples.
- I removed the distracting italics around the
good commit messages.
- I moved the "gather_subscriptions" commit to
the bottom of the list, since we elaborate
on that below the list.
2020-02-24 17:56:36 -08:00
973c6a3061
docs/contributing/version-control: Link to docs/git/fixing-commits.
...
For help with using `git rebase -i`.
2020-02-12 09:53:25 -08:00
4c1453df68
code-style: Modernize some ancient JavaScript advice.
...
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-02-10 14:08:12 -08:00
ed409e8071
docs: Explain commit summary example explicitly.
...
Adds an explicit explanation to help contributors avoid common mistakes
like capitalization errors, missing trailing periods, and incorrectly
prefixing the name of a subsystem.
Fixes #1535 .
2019-12-06 11:39:40 -08:00
93b1c3d94b
settings: Extract config file functions to a module.
...
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2019-11-13 12:38:45 -08:00
6fe5e44b35
settings: Define logging paths with, like, normal human variables.
...
This makes these variables available for type-checking.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2019-11-13 12:38:35 -08:00
18b4a58bc2
docs: Update GSoC/GSoD ideas pages.
...
The main goal is to correct sections that clearly haven't been updated
since 6+ months ago.
2019-10-29 16:07:10 -07:00
fa26475fcf
docs: Deal with a few broken links.
2019-10-15 14:03:53 -07:00
Anders Kaseorg
Alex Vandiver
Tim Abbott
Aman Agrawal
Sumanth V Rao
nikhilmaske-2001
Mohit Gupta
Sharif Naas
Alex Vandiver
Alex Vandiver
Tim Abbott
arpit551
Ray Kraesig
Anders Kaseorg
Stefan Weil
Steve Howell
Chris Bobbe
David Rosa