35c1c8d41b
docs: Apply sentence single-spacing from Prettier.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-09-08 12:06:24 -07:00
915884bff7
docs: Apply bullet style changes from Prettier.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-09-08 12:06:24 -07:00
6145fdf678
docs: Rewrap to avoid line breaks in inline code spans.
...
This works around https://github.com/prettier/prettier/issues/11372 .
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-09-08 12:06:24 -07:00
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
646c04eff2
Rename default branch to ‘main’.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-09-06 12:56:35 -07:00
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
0a3e022376
docs: Adjust list item indentation for Prettier compatibility.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-08-20 23:14:37 -07:00
4bfffc9f74
docs: Fix list item indentation mistakes.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-08-20 23:14:37 -07:00
962f14995e
docs: Fix “sinternet” typo.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-08-20 23:14:37 -07:00
b53e676860
docs: Convert reST index pages to Markdown.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-08-20 06:22:42 -07:00
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
454a900487
docs: Replace chat-zulip-org page with /developer-community/.
2021-07-25 22:17:57 -07:00
e015f3ed7d
docs: Correct “webapp” to “web app”.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-05-14 13:15:38 -07:00
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
bdbc384de5
docs: Reduce the number of apparently broken links on github.
...
- Updated 260+ links from ".html" to ".md" to reduce the number of issues
reported about hyperlinks not working when viewing docs on Github.
- Removed temporary workaround that suppressed all warnings reported
by sphinx build for every link ending in ".html".
Details:
The recent upgrade to recommonmark==0.5.0 supports auto-converting
".md" links to ".html" so that the resulting HTML output is correct.
Notice that links pointing to a heading i.e. "../filename.html#heading",
were not updated because recommonmark does not auto-convert them.
These links do not generate build warnings and do not cause any issues.
However, there are about ~100 such links that might still get misreported
as broken links. This will be a follow-up issue.
Background:
docs: pip upgrade recommonmark and CommonMark #13013
docs: Allow .md links between doc pages #11719
Fixes #11087 .
2019-10-07 12:08:27 -07:00
26abc50219
docs: Replace obsolete chat meetings text with search advice.
2019-10-05 17:57:07 -07:00
04e6c3bd18
docs/version-control: Set commit message line limit to 70.
...
https://github.com/zulip/zulip-mobile/pull/3404#issuecomment-477411875
A discussion followed at
https://chat.zulip.org/#narrow/stream/3-backend/topic/commit.20line.20length
and that was agreed on for the commit message body, but noted that a
length of 76 was acceptable for the summary because of the
single-line constraint and the fact that it ends in a period, making
it clear where it ends.
2019-09-16 15:02:02 -07:00
0d52d24d64
docs: pip upgrade recommonmark and CommonMark
...
Summary:
- recommonmark: 0.4.0 -> 0.5.0
- CommonMark: 0.5.4 -> 0.9.0
- Fixed links getting their .md file extension cut off
- Supressed 262 new warnings
Details:
Appended #anchors to markdown github links as a workaround to
recommonmark 0.5.0 cutting off the ".md" part from them.
Sphinx build would fail as follows
[documentation_crawler] ERROR: Please check link:
<404 https://github.com/zulip/zulipbot/blob/master/.github/CONTRIBUTING >
<404 https://github.com/zulip/zulip/blob/master/requirements/README >
<404 https://github.com/zulip/python-zulip-api/blob/master/zulip_bots/README >
sphinx build would also log a "WARNING: None:any reference target not found"
for every link ending in .html
So a good temporary solution is to suppress all warnings with the method suggested here:
https://stackoverflow.com/questions/37359407/suppress-warnings-for-unfound-references-with-default-role-any-in-sphinx
A better solution would be to edit all links ending .html and use .md instead;
which would also solve PR #11719 .
Fixes #11395 .
2019-08-15 22:41:40 -07:00
3c3471b720
templates: Rename *.handlebars ↦ *.hbs and - ↦ _.
...
Tweaked by tabbott to avoid accidentally disabling the linter for
handlebars templates.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2019-07-12 21:11:03 -07:00
3b6969e4c9
docs: Add link to linkedin to summer-with-zulip.
2019-06-05 17:03:24 -07:00
b52a7aed07
docs: Move tutorials/documenting-api-endpoints to documentation/api.
...
Move docs/tutorials/documenting-api-endpoint.md to
docs/documentation/api.md.
This makes it easier to find when browsing the complete set of
materials on writing Zulip documentation.
2019-05-30 11:12:25 -07:00
fa37c5cee1
docs: Extract a Writing Documentation top-level section.
...
This should make this easier to find, and also makes "Subsystems" a
bit smaller of a catch-all.
2019-05-29 15:52:11 -07:00
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
d0dcee9b59
docs: Make minor edits to gsod-ideas.md.
2019-05-17 11:37:57 -07:00
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
ed81906fc9
docs: Direct GSoD students to #documentation instead of #GSoC.
2019-04-30 14:52:53 -07:00
c1d8b17e49
docs: Stop mentioning legacy Android app in gsoc ideas.
2019-04-25 15:40:09 -07:00
6e2adc6a7b
docs: Update gsod-ideas.md.
2019-04-25 15:38:52 -07:00
edd7a1ab53
docs: Add initial project ideas page for GSoD.
2019-04-19 14:50:06 -07:00
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
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
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
6a540d5773
docs: Fix a couple typos.
2019-03-01 17:06:34 -08:00
c6da0d13cd
docs: Update links to skip help.github.com redirects.
...
help.github.com seems to have a bug where HEAD on a redirected page
returns 404. This causes tools/test-documentation to fail. Fix it by
skipping the redirects.
Signed-off-by: Anders Kaseorg <andersk@mit.edu>
2019-02-26 11:03:08 -08:00
6f5b1903c4
docs: Update code-reviewing docs to reflect CI changes.
2018-12-29 15:28:26 -08:00
3003517430
docs: Move mypy documentation from contributing to testing.
...
The testing section is more appropriate, since it's fundamentally part
of our CI system.
While we're at it, fix the fact that we were linking to GitHub, not
ReadTheDocs, in the run-mypy output.
2018-12-16 21:52:53 -08:00
a3c4ea51f0
docs: Simplify discussion of where mypy is installed.
2018-12-16 21:52:53 -08:00
dc54d290fc
docs: Rearrange mypy documentation ordering.
...
Installation/running is definitely higher priority than stubs for
third-party modules.
2018-12-16 21:52:53 -08:00
f3c6d91e69
mypy: Switch default to daemon mode.
...
There isn't any real advantage to running the non-daemon mode at this
point.
2018-12-16 21:37:58 -08:00
d60a088a49
developer docs: Recommend the mypy daemon for running mypy locally.
...
Resolves #10622 .
2018-10-10 16:29:16 -07:00
58e28fbd21
developer docs: Refer to 'zulipbot add' instead of 'zulipbot label'.
...
These changes are consistent with naming in zulip/zulipbot. See:
- https://github.com/zulip/zulipbot/commit/e29e7eb
- https://github.com/zulip/zulipbot/wiki/Commands#username-add-label-name
2018-09-21 12:16:39 -07:00
038f50b05e
docs: Add basic documentation for adding mypy stubs.
2018-07-26 15:06:22 -07:00
fda786952e
documentation: Migrate all CZO stream links to new stream URL style
...
This includes changes like changing CZO stream URLs from new.20members
to 95-new-members.
2018-05-24 15:15:34 -07:00
e4131fb708
docs: Remove a bunch of content from mypy docs.
...
All of this content had become obsolete due to our successful adoption
of mypy.
2018-05-13 17:23:18 -07:00
f34b72b830
docs: Fix command for accessibility label.
2018-04-19 11:13:09 -07:00
986e55e5b0
docs: Move summer with Zulip doc from Dropbox paper to ReadTheDocs.
...
Originally authored mostly by Tim Abbott.
2018-04-01 22:11:45 -07:00
e1ab6ceccc
docs: Clarify description by changing 'disrupting' to 'disturbing'.
2018-03-08 15:10:23 -08:00
baffcf0948
Fix: broken link zulip/zulipbot
2018-03-05 10:51:56 -08:00
be3d43bb46
lint: Add linter rule banning $.get and friends.
...
These are not allowed in our style guide.
2018-02-13 16:47:59 -08:00
68d5471045
docs: Add code-of-conduct to the main navigation tree.
...
This quiets the last of the warnings that Sphinx was giving us about
documents not being in any toctree, now that we've explicitly told it
with `:orphan:` about the documents we intentionally don't link there.
2018-01-24 14:37:17 -08:00
a61e032a3b
docs/contributing/mypy: Small wording fixes.
2018-01-24 14:37:17 -08:00
Anders Kaseorg
Tim Abbott
Alex Vandiver
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
Chris Bobbe
Rishi Gupta
Rafid Aslam
Vishnu Ks
Marco Burstein
Samuel Searles-Bryant
Mateusz Mandera
Anders Kaseorg
Jack Zhang
Abhigyan Khaund
Puneeth Chaganti
cg-cnu
Shivam Gera
Greg Price