Eeshan Garg
3bab91079f
external links: Migrate the rest of /developer-community links.
...
We recently changed /developer-community to /development-community.
Now that this change is in production, we can also migrate the
external links in our ReadTheDocs documentation.
2021-12-09 12:14:26 -08:00
AEsping
55f9178506
dev docs: Update Black link.
...
Updates the link to the editior integration for Black.
2021-11-30 14:36:29 -08:00
AEsping
6ad1c5c8ed
docs:: Update GSoC application tips.
...
- Add missing link for GitHub.
- Fix broken links to Matt Ringel's blog post.
- Add link to Julia Evans blog post.
- Add section heading for "Questions Are Important."
- Rearrange some content to fit with new section heading.
With additional tweaks from tabbott:
* Avoid linking to chat.zulip.org not via our documentation.
* Avoid the CZO abbreviation.
2021-11-23 16:05:33 -08:00
Ankur
c578f186b6
docs: Change chat.zulip.org links to zulip.com/developer-community.
...
This helps increase the probability that folks read the guidelines for how the
chat.zulip.org community works and what streams to use before arriving there.
Fixes #19827 .
2021-11-17 22:25:55 -08:00
Anders Kaseorg
a4dbc1edd4
docs: Format Markdown with Prettier.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-09-08 12:06:24 -07:00
Anders Kaseorg
35c1c8d41b
docs: Apply sentence single-spacing from Prettier.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-09-08 12:06:24 -07:00
Anders Kaseorg
915884bff7
docs: Apply bullet style changes from Prettier.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-09-08 12:06:24 -07:00
Anders Kaseorg
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
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
Anders Kaseorg
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
Anders Kaseorg
4bfffc9f74
docs: Fix list item indentation mistakes.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-08-20 23:14:37 -07:00
Anders Kaseorg
962f14995e
docs: Fix “sinternet” typo.
...
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
Tim Abbott
454a900487
docs: Replace chat-zulip-org page with /developer-community/.
2021-07-25 22:17:57 -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
Anders Kaseorg
544bbd5398
docs: Fix capitalization mistakes.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-05-10 09:57: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
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
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
Tim Abbott
5fef101189
docs: Document zulip-archive GSoC idea.
2021-03-23 15:03:48 -07:00
Tim Abbott
a025726b62
docs: Remove reference to old length of GSoC projects.
2021-03-16 15:40:41 -07:00
Aman Agrawal
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
Tim Abbott
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
Sumanth V Rao
ed3a230374
docs: Add guidlines for responding to a review feedback.
2021-03-06 05:45:35 -05:00
nikhilmaske-2001
77194de136
docs: Correct typos in GSoC ideas doc.
2021-02-23 20:51:59 -08:00
Sumanth V Rao
94d6dd5ee5
docs: Update author protocol section of the code-reviewing docs.
2021-02-20 09:17:53 -05:00
Tim Abbott
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
Tim Abbott
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
Tim Abbott
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
Anders Kaseorg
a0d0b89adb
docs: Document Black and isort.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 15:31:59 -08:00
Tim Abbott
70c813e690
docs: Warn about the 'partially fixes' GitHub bug.
2020-12-18 12:49:16 -08:00
Tim Abbott
992c6126a8
docs: Update many references to Casper.
2020-08-30 17:16:02 -07:00
Alex Vandiver
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
Anders Kaseorg
c155403884
docs: Fix various capitalization errors.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-08-11 10:25:52 -07:00
Anders Kaseorg
768f9f93cd
docs: Capitalize Markdown consistently.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-08-11 10:23:06 -07:00
Anders Kaseorg
c6ed5c81de
styles: Format CSS with Prettier.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-08-04 16:34:19 -07:00
Anders Kaseorg
ab6ed22bff
docs: Document that we use Prettier.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-07-22 15:49:48 -07:00
Mohit Gupta
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
Tim Abbott
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
Tim Abbott
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
Sharif Naas
17afd460bc
docs: Fix typos in contributing/code-style.md.
2020-06-08 11:13:32 -07:00
Anders Kaseorg
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
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
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