paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-02 21:13:36 +00:00
Code Issues Packages Projects Releases Wiki Activity
40,912 Commits 30 Branches 160 Tags
42379a8cd1b7b09246ce7c0c500e15eda379a395
Commit Graph

82 Commits

Author SHA1 Message Date
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
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
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
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
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
Anders Kaseorg
7ff9b22500 docs: Convert many http URLs to https. 
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
 2020-03-26 21:35:32 -07:00
Stefan Weil
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
Steve Howell
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
Chris Bobbe
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
Anders Kaseorg
4c1453df68 code-style: Modernize some ancient JavaScript advice. 
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
 2020-02-10 14:08:12 -08:00
David Rosa
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
Anders Kaseorg
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
Anders Kaseorg
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
Tim Abbott
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
Tim Abbott
fa26475fcf docs: Deal with a few broken links. 2019-10-15 14:03:53 -07:00
David Rosa
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
Tim Abbott
26abc50219 docs: Replace obsolete chat meetings text with search advice. 2019-10-05 17:57:07 -07:00
Chris Bobbe
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
David Rosa
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
Anders Kaseorg
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
Rishi Gupta
3b6969e4c9 docs: Add link to linkedin to summer-with-zulip. 2019-06-05 17:03:24 -07:00
Rafid Aslam
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
Tim Abbott
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
Tim Abbott
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