Commit Graph

151 Commits

Author SHA1 Message Date
Anders Kaseorg 7afb12ee26 README: Add Ruff badge.
Because Ruff is awesome.

Signed-off-by: Anders Kaseorg <anders@zulip.com>
2023-01-04 16:22:12 -08:00
Danish fa02eb6c93 README: Tweak grammar and minor language details.
With some additional edits by tabbott.
2022-09-01 11:57:32 -07:00
Tim Abbott 95dfde121c docs: Update global links to new contributing guide URL.
Logically, these are part of the previous commit, but won't pass CI
until ReadTheDocs has built the previous commit and generated the
target page.
2022-08-25 11:25:02 -07:00
Alya Abbott ba1f804518 docs: Update README and installation guide.
This is a general cleanup that also aims to link to the new
self-hosting page to provide added context.
2022-03-04 13:59:17 -08:00
Alya Abbott 669010494e portico: Update contributor count from 700 to 1000.
Note: I did not check whether we have numbers other than 700 that also
need to be updated.
2022-01-24 12:41:49 -08:00
Alya Abbott ff07050eb7 docs: Update README.md description. 2022-01-07 14:42:50 -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
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 646c04eff2 Rename default branch to ‘main’.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-09-06 12:56:35 -07:00
Tim Abbott 454a900487 docs: Replace chat-zulip-org page with /developer-community/. 2021-07-25 22:17:57 -07:00
Alya Abbott 844c62c64e portico: Create new "Zulip for communities" page. 2021-07-18 12:10:33 -07:00
Vishnu KS 8e34bf4349 readme: Add GitHub sponsors badge in README.
The number is really low, since we haven't told anyone about our
GitHub Sponsors site, so the badge probably isn't actually helpful,
but I suppose that's OK.
2021-03-23 15:56:46 -07:00
Vishnu KS e7528b58c0 readme: Mention GitHub sponsors program. 2021-03-23 15:55:09 -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 158752ca9b docs: Update contributor and developer documentation counts. 2021-02-15 17:45:34 -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
Anders Kaseorg 72d6ff3c3b docs: Fix more capitalization issues.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-10-23 11:46:55 -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 7ee974729b docs: Replace Digital Ocean with DigitalOcean.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-07-30 11:30:43 -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
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 bb0b82f397 docs: Fix "report an issue" link in README.md.
This link has been broken since it was added in November 2017, when
CONTRIBUTING.md was split out of README.md in
ee2ea3750c.
2020-06-01 18:31:05 -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
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
Tim Abbott 23c48764b5 README: Improve links to coverage/CI to point to master.
Apparently, the CircleCI and Codecov links (and the Codecov badge)
weren't pointing specifically at master, so they'd sometimes show
state from the lastest push to a pull request, which isn't a
reasonable way to advertise whether the project's build is passing.
2019-10-01 15:31:55 -07:00
Rishi Gupta 81f06ab375 readme: Remove Travis badge.
Travis hasn't been our primary CI system for a long time, and flakes,
and the badges look duplicate with the CircleCI one, so we should just
remove it.

See discussion at
https://chat.zulip.org/#narrow/stream/101-design/topic/github.20badges.
2019-09-06 13:14:14 -07:00
Rishi Gupta 34dee2d953 readme: Advertise digital ocean droplet and docker install. 2019-09-06 13:14:01 -07:00
Anders Kaseorg bfa82a70c8 ci: Remove Ubuntu 14.04 (trusty) from CI.
Tweaked by tabbott to improve our CI docs discussion of these.

Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2019-06-26 11:01:13 -07:00
Tim Abbott d0d497fc2d docs: Update contributor count to over 500. 2019-06-03 12:14:40 -07:00
Cynthia Lin fb408316f1 README: Normalize CircleCI badge styling. 2018-11-18 18:49:22 -08:00
Cynthia Lin 10a21ed949 README: Add latest GitHub release badge to README. 2018-11-18 18:49:22 -08:00
Tim Abbott bf77158dbc docs: Remove links to long-obsolete /plans.html.
We were previously sending users to a redirect, and that redirect
recently broke.
2018-11-07 08:11:07 -08:00
Tim Abbott 19e099c9fc README: Document support for Debian and Bionic. 2018-07-01 01:47:03 -07:00
Tim Abbott 6e5d6da7f9 README: Fix link to now- obsolete 1.7.1 release.
We should really be linking to the latest stable release.
2018-04-25 12:00:07 -07:00
Vishnu Ks ebe16e064e README: Include CircleCI build status badge.
For now, we still need the Travis badge, since Travis is where we test the 
production installation process.  But ideally, we'll end up removing that too.
2018-02-08 18:24:43 -08:00
Greg Price 50ea5ff4b1 version: Update mentions of latest release to reflect 1.7.1. 2017-11-22 18:11:20 -08:00
Greg Price de2a2d0dfa docs: Send people to install instructions for latest release.
Pointing these at the latest release, rather than the latest version
in master, allows us to make changes to the installer and document
them properly in master, without making the instructions confusingly
wrong for people who just go to the website or the GitHub repo page
and follow instructions to install.
2017-11-20 15:52:07 -08:00
Tim Abbott 484ded60ce docs: Fix unintentional whitespace in ReadTheDocs homepage. 2017-11-17 11:03:08 -08:00
Tim Abbott 7c24e04223 lint: Fix long lines in README.md. 2017-11-16 11:38:13 -08:00
Tim Abbott 638eb7a8e4 docs: Update links to ReadTheDocs to always use https.
This is better security practice.

We also add a lint rule to enforce this for the future.
2017-11-16 10:59:24 -08:00
Tim Abbott 07c2b205a4 docs: Update absolute links to point to new URLs.
This should get test-documentation and test-help-documentation passing
again after we moved everything around in the last commit.

There are a lot more absolute links (generally in code comments) to
update, but they are lower-priority and can be done in a follow-up
pass.
2017-11-16 10:08:22 -08:00
Rishi Gupta f7d23ee38b docs: Make minor updates to CONTRIBUTING.md and README.md. 2017-11-15 11:16:28 -08:00
Rishi Gupta 2d73d3d1d4 docs: Move license declaration from README.md to LICENSE. 2017-11-14 16:04:23 -08:00
Rishi Gupta ee2ea3750c docs: Split a CONTRIBUTING.md out of README.md.
Also contains a number of updates, additions, and deletions; this is
essentially a rewrite of the github landing page experience.
2017-11-14 16:04:23 -08:00
Rishi Gupta d1f0d2bdc1 docs: Update the pitch at the top of README.md. 2017-11-10 16:42:19 -08:00
akashnimare 608a594256 docs: Update desktop app version to stable 2017-11-03 15:08:57 -07:00
Tim Abbott b511e9d0a9 docs: Recommend Xenial over Trusty for new installations. 2017-10-20 14:34:48 -07:00
Mohd Ali Rizwi 5cfc56e772 docs: Updated bite-size label name in README.
This label got renamed to "good first issue" thanks to GitHub, and we updated
the link, but not the text.
2017-10-13 15:06:36 -07:00
Tim Abbott daeb4e0ca3 docs: Fix link to bite-size issues to point to new name. 2017-10-12 23:09:02 -07:00