Commit Graph

65 Commits

Author SHA1 Message Date
Tim Abbott c95773118e CONTRIBUTING: Add links to new review process guide.
These links could not be merged without breaking CI in the previous
commits.
2023-05-25 18:10:22 -07:00
Alya Abbott afc016c0f0 docs: Add a page documenting review process for pull requests.
- Move the "Submitting a pull request" and "Stages of a pull
request" sections of the contributing guide to a dedicated page.
- Add more detail.
2023-05-25 13:16:56 -07:00
Lauryn Menard 53ed7d5ce2 docs: Remove paragraph about getting help finding issues in contributing.
Removes a paragraph about posting in the new members stream to get
help finding issues to work on from the first contribution part of
the contributing guide.

Also updates the remaining section about posting to new members as
a way to introduce yourself with a link to the community norms and
offering positive feedback as well as constructive criticism.
2023-01-17 14:51:53 -08:00
Alya Abbott 1176f1e674 contributor docs: Add guidance on claiming a second issue. 2022-12-14 21:11:47 -08:00
David Rosa e31070c480 contributing docs: Update "Version Control" > "Commit discipline" links.
Updates `.html` links as a follow-up to #23750.
2022-12-09 13:28:49 -08:00
Alya Abbott a674de5cf8 docs: Copy Zulip development community intro to Contributing guide. 2022-10-31 10:15:22 -07:00
Alya Abbott b0ca7e3d2e docs: Link to Design discussions page from CONTRIBUTING.MD. 2022-10-03 11:36:34 -07:00
Tim Abbott 53015471f3 docs: Fix broken link to outreach overview page. 2022-09-21 22:23:35 -07:00
Alya Abbott e03afc2b3c docs: Add links to new contributor docs to overall guide. 2022-09-21 21:57:47 -07:00
Alya Abbott 6e2f781cf7 docs: Shorten "Outreach programs" section in contributor guide. 2022-09-21 21:57:45 -07:00
Anders Kaseorg 7d485aa58f docs: Correct more “webapp” to “web app”.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-09-08 20:23:28 -07:00
Alya Abbott ceb14351dd contributor docs: Clarify instructions for claiming an issue. 2022-09-07 10:42:51 -07:00
David Rosa 5cac44be06 docs: Reorganize sections and pages about contributing to Zulip.
We should rearrange Zulip's developer docs to make it easier to
find the documentation that new contributors need.

Name changes
Rename "Code contribution guide" section -> "Contributing to Zulip".
Rename "Contributing to Zulip" page -> "Contributing guide".

Organizational changes to the newly-named "Contributing to Zulip":
Move up "Contributing to Zulip", as the third link in sidebar index.
Move up renamed "Contributing guide" page to the top of this section.
Move up "Zulip code of Conduct", as the second link of this section.
Move down "Licensing", as the last link of this section.
Move "Accessibility" just below "HTML and CSS" in Subsystems section.

Update all links according to the changes above.
Redirects should be added as needed.

Fixes: #22517.
2022-08-25 11:24:57 -07:00
Alya Abbott ff93c6ed69 docs: Link to new licensing page from main CONTRIBUTING page. 2022-07-07 14:06:34 -07:00
Anders Kaseorg 251198044f docs: Update WIP PR convention to GitHub draft PRs.
Since GitHub supports draft PRs, our [WIP] convention is obsolete.

Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-06-28 13:16:38 -07:00
Alya Abbott 20bb1b70d1 docs: Clarify stages of PR review. 2022-03-25 18:11:18 -07:00
Tim Abbott ee7f56724b CONTRIBUTING: Advertise Git guide more clearly. 2022-03-01 22:18:42 -08:00
Alya Abbott e2683b7f09 docs: Update contributing guide to clearly point to code review doc. 2022-03-01 21:04:42 -08:00
Alya Abbott 30fec0c701 docs: Clarify that only issues tagged "help wanted" should be claimed. 2022-02-01 11:26:09 -08:00
Alya Abbott 6ee09e6290 developer docs: Address PR feedback. 2022-01-28 08:29:40 -08:00
Alya Abbott c390d10fb3 developer docs: Extend contributor guide.
Covers why someone's PR might not be merged right away.
2022-01-28 08:29:40 -08:00
Tim Abbott ce5153adee CONTRIBUTING: Update GSoC guide link.
This change conceptually belongs in the previous commit, but would
fail CI if the previous commit hadn't been built on ReadTheDocs yet.
2022-01-19 11:39:51 -08:00
Abhijeet Prasad Bodas 12eb52221b docs: Rename `contributing/gsoc-ideas` -> `contributing/gsoc`.
This page contains a lot of other material related to GSoC than
just project ideas.
We would also want to add a redirect from the old URL to the new
one from the RTD admin page.
2022-01-19 11:35:33 -08:00
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
Alya Abbott 27cd70d999 dev docs: Address feedback on Contributing guide. 2021-11-24 14:12:25 -08:00
Alya Abbott d09997f32e dev docs: Improve new contributor guide.
The main focus is on improving the instructions around claiming issues
to try to create less issue claiming spam.

Additionally, we haven't done a detailed update in a few years, and
some of the content is stale/irrelevant.
2021-11-23 17:01:53 -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
Tim Abbott 454a900487 docs: Replace chat-zulip-org page with /developer-community/. 2021-07-25 22:17:57 -07:00
Vishnu KS 61c8dda476 docs: Mention GitHub sponsors in contributing guide. 2021-03-23 15:57:25 -07: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
Nikhil 9c3ff29d35 docs: Added number of selected participants in GSoC 2020. 2020-11-09 20:26:56 -08:00
Tim Abbott f6376d57e4 docs: Tweak descriptions of zulip-devel-announce and friends. 2020-09-03 17:39:16 -07:00
Thomas Güttler 7089f8c04d docs: Hyperlink to zulip-devel-announce added.
This way it is a bit simpler for users to find the page to subscribe.
2020-09-03 17:39: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
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
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
Divyanshu Agrawal cd9a9908ca
docs: Fix some small errors in CONTRIBUTING.md.
Some of these errors were identified using Grammarly, and others
while reading.
2020-03-19 11:15:23 -07:00
Tim Abbott b775becc68 docs: Change our security contact to security@.
This has for a while been our only active Google Groups mailing list,
and given that folks will guess security@ as our security contact, we
might as well just standardize on that.

Also tweak some ambiguous text; it wouldn't be appropriate for us to
issue a CVE for e.g. an operational issue only affecting us.
2020-02-26 16:35:29 -08:00
Tim Abbott 19f1c4e1e3 docs: Update discussion of outreach programs.
"Outreach programs" I think is better phrasing than "Internship
programs", since GSoC is the main one we do these days and isn't an
internship program.

This may fail CI since it contains links to anchors on ReadTheDocs
that may race; it should fail ones the ReadTheDocs build completes.
2020-02-25 11:47:09 -08:00
Alex Dehnert 998b52dd8c docs: Remove mention of Dropbox CLA.
Based on discussion in https://chat.zulip.org/#narrow/stream/19-documentation/topic/CLA and 
https://chat.zulip.org/#narrow/stream/105-zulipbot/topic/New.20contributor.20definition, signing 
the Dropbox CLA is no longer a requirement, and it's a essentially a documentation bug that it's 
still mentioned.
2019-12-14 22:07:38 -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
Vishnu Ks d1007c0a6b docs: Mention twitter account as alternative to mailing list. 2019-05-20 15:21:15 -07:00
Vishnu Ks 6c6754d41c docs: Update mailing list id in contributing.md. 2019-05-20 15:21:15 -07:00
Kanishk Kakar 77ab9a0eb0 docs: Update desktop repo URL. 2019-05-20 11:01:11 -07:00
Marco Burstein 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
Tim Abbott cc4774f371 docs: Update our language on finding a first issue.
We might want to do another pass on this, but I at least want to
de-emphasize "good first issue" since we're not maintaining that
label.
2019-03-07 20:04:04 -08:00
Tim Abbott 30e5b5fe55 docs: Increase highlighting of our linters in documentation. 2018-11-29 14:17:13 -08:00