Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/templates/zerver/for/open-source.md

156 lines
6.9 KiB
Markdown
Raw Normal View History

portico: Typographical nitpicking. Punctuate marketing headings with a period. Fix a couple of title-cased headings to sentense case. Consistently use curly apostrophes, curly quotation marks, and Unicode ellipses. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-18 00:09:39 +01:00
Below, we’ve collected a list of [Zulip features](/features) that are
portico: Clean up /for/open-source. - Remove essay portion and link to /for/communities instead. - Copy over relevant quotes from /for/communities. - Move "Join the hundreds of open-source projects we sponsor."
2021-07-28 01:35:18 +02:00
particularly useful to open source communities. We also recommend
checking out [Zulip for communities](/for/communities) to learn how
Zulip empowers welcoming communities by making it easy to participate
on your own time.
<br />
<blockquote class="twitter-tweet"><p lang="en" dir="ltr">When we made the switch to <a href="https://twitter.com/zulip?ref_src=twsrc%5Etfw">@zulip</a> a few months ago for chat, never in my wildest dreams did I imagine it was going to become the beating heart of the community, and so quickly. It&#39;s a game changer. 🧑‍💻🗨️👩‍💻</p>&mdash; Dan Allen (@mojavelinux) <a href="https://twitter.com/mojavelinux/status/1409702273400201217?ref_src=twsrc%5Etfw">June 29, 2021</a></blockquote>
<br />
portico: Update for/open-source.
2017-07-28 20:02:28 +02:00
portico: Typographical nitpicking. Punctuate marketing headings with a period. Fix a couple of title-cased headings to sentense case. Consistently use curly apostrophes, curly quotation marks, and Unicode ellipses. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-18 00:09:39 +01:00
### Moderation suite.
open source: Add a more complete "why zulip" explanation. Also contains a lot of edits from Rishi, including to the content around Zulip's features and what to highlight there.
2019-09-12 21:45:16 +02:00
Moderation is a big part of making an open community work. Zulip was built
for open communities from the beginning and comes with
[moderation tools](/help/moderating-open-organizations) out of the box.
portico: Typographical nitpicking. Punctuate marketing headings with a period. Fix a couple of title-cased headings to sentense case. Consistently use curly apostrophes, curly quotation marks, and Unicode ellipses. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-18 00:09:39 +01:00
### Open invitations.
portico: Update for/open-source.
2017-07-28 20:02:28 +02:00
Allow anyone to
help: Rework docs for joining and inviting.
2019-02-27 07:14:13 +01:00
[join without an invitation](/help/allow-anyone-to-join-without-an-invitation).
help: Rename join-zulip-chat-badge to linking-to-zulip.
2019-04-14 06:03:49 +02:00
You can also link to your Zulip with a [badge](/help/linking-to-zulip)
portico: Update for/open-source.
2017-07-28 20:02:28 +02:00
in your readme document.
portico: Typographical nitpicking. Punctuate marketing headings with a period. Fix a couple of title-cased headings to sentense case. Consistently use curly apostrophes, curly quotation marks, and Unicode ellipses. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-18 00:09:39 +01:00
### Authenticate with GitHub or GitLab.
portico: Update for/open-source.
2017-07-28 20:02:28 +02:00
docs: Advertise support for GitLab authentication.
2020-02-11 23:13:09 +01:00
Allow (or require) users to authenticate with their [GitHub or GitLab
account](/help/configure-authentication-methods), instead of with a
username and password.
landing: Write up why open source projects should use Zulip This isn't very slick, but it should get the main points down, and it's past time we got something like this up. Definitely needs in the future another pass at the text, and also some images (screenshots, etc.) and styling.
2017-06-19 00:47:02 +02:00
[github-auth]: https://github.com/zulip/zulip/blob/7e9926233/zproject/prod_settings_template.py#L112
data_import: Document Rocket.Chat import tool.
2021-07-24 23:39:05 +02:00
### Import from Slack, Mattermost, Gitter, or Rocket.Chat.
portico: Add Slack/Gitter import to for/open-source.
2018-07-25 05:35:49 +02:00
open source: Add a more complete "why zulip" explanation. Also contains a lot of edits from Rishi, including to the content around Zulip's features and what to highlight there.
2019-09-12 21:45:16 +02:00
Import your existing organization from [Slack](/help/import-from-slack),
data_import: Document Rocket.Chat import tool.
2021-07-24 23:39:05 +02:00
[Mattermost](/help/import-from-mattermost),
[Gitter](/help/import-from-gitter), or
[Rocket.Chat](/help/import-from-rocketchat).
portico: Add Slack/Gitter import to for/open-source.
2018-07-25 05:35:49 +02:00
portico: Clean up /for/open-source. - Remove essay portion and link to /for/communities instead. - Copy over relevant quotes from /for/communities. - Move "Join the hundreds of open-source projects we sponsor."
2021-07-28 01:35:18 +02:00
<br />
<blockquote class="twitter-tweet" data-cards="hidden"><p lang="en" dir="ltr">We just moved the Lichess team (~100 persons) to <a href="https://twitter.com/zulip?ref_src=twsrc%5Etfw">@zulip</a>, and I&#39;m loving it. The topics in particular make it vastly superior to slack &amp; discord, when it comes to dealing with many conversations.<br>Zulip is also open-source! <a href="https://t.co/lxHjf3YPMe">https://t.co/lxHjf3YPMe</a></p>&mdash; Thibault D (@ornicar) <a href="https://twitter.com/ornicar/status/1412672302601457664?ref_src=twsrc%5Etfw">July 7, 2021</a></blockquote>
<br />
help: Document playgrounds on /help, /features and /for/open-source. Linked the Help Center document in places like - zulip.yaml (/events, /register/, realm/playgrounds, /realm/playgrounds/{playground_id}) - /help/format-your-message-using-markdown (Linked to make users reading the markdown code block style, aware of this feature) - /templates/settings/playground_settings_admin.hbs (Linked as a reference to read more about playgrounds before configuring one) Also showcase the feature on /features and /for/open-source.
2021-04-18 14:49:02 +02:00
### Collaborate on code and formulas
portico: Update for/open-source.
2017-07-28 20:02:28 +02:00
user docs: Create separate "Code blocks" user documentation page. * Move the extended documentation of code blocks to a separate page. * Merge "code playgrounds" documentation to be a section of that page. * Document copy widget on code blocks. * This commit changes how we refer to "```python" type syntax for code blocks. Instead of being called a syntax highlighting label, this is now referred to as a "language tag", since it serves both syntax highlighting and playgrounds. * Remap all the links. * Advertise this new page in various places that previously did not have a link.
2021-05-05 02:05:47 +02:00
[Markdown code blocks](/help/code-blocks)
help: Document playgrounds on /help, /features and /for/open-source. Linked the Help Center document in places like - zulip.yaml (/events, /register/, realm/playgrounds, /realm/playgrounds/{playground_id}) - /help/format-your-message-using-markdown (Linked to make users reading the markdown code block style, aware of this feature) - /templates/settings/playground_settings_admin.hbs (Linked as a reference to read more about playgrounds before configuring one) Also showcase the feature on /features and /for/open-source.
2021-04-18 14:49:02 +02:00
with syntax highlighting make it easy to discuss code, paste an error
message, or explain a complicated point. Native LaTeX support provides
the same benefits when talking about math.
You can also instantly copy a code block to your clipboard or transfer
user docs: Create separate "Code blocks" user documentation page. * Move the extended documentation of code blocks to a separate page. * Merge "code playgrounds" documentation to be a section of that page. * Document copy widget on code blocks. * This commit changes how we refer to "```python" type syntax for code blocks. Instead of being called a syntax highlighting label, this is now referred to as a "language tag", since it serves both syntax highlighting and playgrounds. * Remap all the links. * Advertise this new page in various places that previously did not have a link.
2021-05-05 02:05:47 +02:00
it to an [external code playground](/help/code-blocks#code-playgrounds) to
help: Document playgrounds on /help, /features and /for/open-source. Linked the Help Center document in places like - zulip.yaml (/events, /register/, realm/playgrounds, /realm/playgrounds/{playground_id}) - /help/format-your-message-using-markdown (Linked to make users reading the markdown code block style, aware of this feature) - /templates/settings/playground_settings_admin.hbs (Linked as a reference to read more about playgrounds before configuring one) Also showcase the feature on /features and /for/open-source.
2021-04-18 14:49:02 +02:00
interactively run and debug the code.
portico: Update for/open-source.
2017-07-28 20:02:28 +02:00
markdown: Allow setting a default language for code blocks. This adds a new realm setting: default_code_block_language. This PR also adds a new widget to specify a language, which behaves somewhat differently from other widgets of the same kind; instead of exposing methods to the whole module, we just create a single IIFE that handles all the interactions with the DOM for the widget. We also move the code for remapping languages to format_code function since we want to preserve the original language to decide if we override it using default_code_clock_language. Fixes #14404.
2020-03-31 15:21:27 +02:00
If your community primarily uses a single programming language,
user docs: Create separate "Code blocks" user documentation page. * Move the extended documentation of code blocks to a separate page. * Merge "code playgrounds" documentation to be a section of that page. * Document copy widget on code blocks. * This commit changes how we refer to "```python" type syntax for code blocks. Instead of being called a syntax highlighting label, this is now referred to as a "language tag", since it serves both syntax highlighting and playgrounds. * Remap all the links. * Advertise this new page in various places that previously did not have a link.
2021-05-05 02:05:47 +02:00
consider setting a [default code block language](/help/code-blocks#default-code-block-language).
markdown: Allow setting a default language for code blocks. This adds a new realm setting: default_code_block_language. This PR also adds a new widget to specify a language, which behaves somewhat differently from other widgets of the same kind; instead of exposing methods to the whole module, we just create a single IIFE that handles all the interactions with the DOM for the widget. We also move the code for remapping languages to format_code function since we want to preserve the original language to decide if we override it using default_code_clock_language. Fixes #14404.
2020-03-31 15:21:27 +02:00
portico: Typographical nitpicking. Punctuate marketing headings with a period. Fix a couple of title-cased headings to sentense case. Consistently use curly apostrophes, curly quotation marks, and Unicode ellipses. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-18 00:09:39 +01:00
### Permalink to conversations.
portico: Update for/open-source.
2017-07-28 20:02:28 +02:00
open source: Add a more complete "why zulip" explanation. Also contains a lot of edits from Rishi, including to the content around Zulip's features and what to highlight there.
2019-09-12 21:45:16 +02:00
Zulip makes it easy to get a [permanent link to a
conversation](/help/link-to-a-message-or-conversation), which you can
use in your issue tracker, forum, or anywhere else. Zulip’s
topic-based threading helps keep conversations coherent and organized
so they are useful for posterity.
portico: Update for/open-source.
2017-07-28 20:02:28 +02:00
portico: Typographical nitpicking. Punctuate marketing headings with a period. Fix a couple of title-cased headings to sentense case. Consistently use curly apostrophes, curly quotation marks, and Unicode ellipses. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-18 00:09:39 +01:00
### Link from chat to issues.
portico: Update for/open-source.
2017-07-28 20:02:28 +02:00
Efficiently refer to issues or code reviews with notation like `#1234` or
`T1234`. You can set up any regex as a
refactor: Rename filter to linkifier in frontend code and docs. This only leaves `page_params.realm_filters`, which will be changed in further commits along with the API change.
2021-03-13 18:15:14 +01:00
[custom linkification filter](/help/add-a-custom-linkifier) for
portico: Update for/open-source.
2017-07-28 20:02:28 +02:00
your organization.
landing: Write up why open source projects should use Zulip This isn't very slick, but it should get the main points down, and it's past time we got something like this up. Definitely needs in the future another pass at the text, and also some images (screenshots, etc.) and styling.
2017-06-19 00:47:02 +02:00
portico: Typographical nitpicking. Punctuate marketing headings with a period. Fix a couple of title-cased headings to sentense case. Consistently use curly apostrophes, curly quotation marks, and Unicode ellipses. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-18 00:09:39 +01:00
### Hundreds of integrations.
landing: Write up why open source projects should use Zulip This isn't very slick, but it should get the main points down, and it's past time we got something like this up. Definitely needs in the future another pass at the text, and also some images (screenshots, etc.) and styling.
2017-06-19 00:47:02 +02:00
docs: Fix capitalization mistakes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-05-10 07:02:14 +02:00
Get events from GitHub, Travis CI, Jira, and
portico: Update for/open-source.
2017-07-28 20:02:28 +02:00
[hundreds of other tools](/integrations) right in Zulip. Topics give each
issue its own place for discussion.
landing: Write up why open source projects should use Zulip This isn't very slick, but it should get the main points down, and it's past time we got something like this up. Definitely needs in the future another pass at the text, and also some images (screenshots, etc.) and styling.
2017-06-19 00:47:02 +02:00
portico: Clean up /for/open-source. - Remove essay portion and link to /for/communities instead. - Copy over relevant quotes from /for/communities. - Move "Join the hundreds of open-source projects we sponsor."
2021-07-28 01:35:18 +02:00
> “Wikimedia uses Zulip for its participation in open source
> mentoring programs. Zulip’s threaded discussions help busy
> organization administrators and mentors stay in close communication
> with students during all phases of the programs.”
> — Srishti Sethi, Developer Advocate, Wikimedia Foundation
docs: Recommend Matterbridge for integration with IRC/Matrix/Slack.
2020-11-20 08:22:15 +01:00
### Mirror IRC, Matrix, or Slack.
portico: Move on-premise features below fold in for/open-source. This hasn't seemed like a deciding factor for open source orgs in the last year.
2018-07-25 05:34:10 +02:00
docs: Recommend Matterbridge for integration with IRC/Matrix/Slack.
2020-11-20 08:22:15 +01:00
Two-way integrations with IRC, Matrix, and/or Slack using
[Matterbridge](https://github.com/42wim/matterbridge).
portico: Move on-premise features below fold in for/open-source. This hasn't seemed like a deciding factor for open source orgs in the last year.
2018-07-25 05:34:10 +02:00
portico: Typographical nitpicking. Punctuate marketing headings with a period. Fix a couple of title-cased headings to sentense case. Consistently use curly apostrophes, curly quotation marks, and Unicode ellipses. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-18 00:09:39 +01:00
### Scales to 10,000s of members.
landing: Write up why open source projects should use Zulip This isn't very slick, but it should get the main points down, and it's past time we got something like this up. Definitely needs in the future another pass at the text, and also some images (screenshots, etc.) and styling.
2017-06-19 00:47:02 +02:00
open source: Add a more complete "why zulip" explanation. Also contains a lot of edits from Rishi, including to the content around Zulip's features and what to highlight there.
2019-09-12 21:45:16 +02:00
Zulip is designed to perform well in common use cases for open source
projects, with features like [soft
deactivation](https://zulip.readthedocs.io/en/latest/subsystems/sending-messages.html#soft-deactivation)
to make message delivery efficient even when sending to a stream with
10,000s of inactive subscribers.
landing: Write up why open source projects should use Zulip This isn't very slick, but it should get the main points down, and it's past time we got something like this up. Definitely needs in the future another pass at the text, and also some images (screenshots, etc.) and styling.
2017-06-19 00:47:02 +02:00
portico: Typographical nitpicking. Punctuate marketing headings with a period. Fix a couple of title-cased headings to sentense case. Consistently use curly apostrophes, curly quotation marks, and Unicode ellipses. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-18 00:09:39 +01:00
### Full-text search of all public history.
landing: Write up why open source projects should use Zulip This isn't very slick, but it should get the main points down, and it's past time we got something like this up. Definitely needs in the future another pass at the text, and also some images (screenshots, etc.) and styling.
2017-06-19 00:47:02 +02:00
portico: Typographical nitpicking. Punctuate marketing headings with a period. Fix a couple of title-cased headings to sentense case. Consistently use curly apostrophes, curly quotation marks, and Unicode ellipses. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-18 00:09:39 +01:00
Zulip’s [full-text search](/help/search-for-messages) supports
searching the organization’s entire public history via the
open source: Add a more complete "why zulip" explanation. Also contains a lot of edits from Rishi, including to the content around Zulip's features and what to highlight there.
2019-09-12 21:45:16 +02:00
`streams:public` search operator, allowing Zulip to provide all the
benefits of a searchable project forum.
landing: Write up why open source projects should use Zulip This isn't very slick, but it should get the main points down, and it's past time we got something like this up. Definitely needs in the future another pass at the text, and also some images (screenshots, etc.) and styling.
2017-06-19 00:47:02 +02:00
portico: Typographical nitpicking. Punctuate marketing headings with a period. Fix a couple of title-cased headings to sentense case. Consistently use curly apostrophes, curly quotation marks, and Unicode ellipses. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-18 00:09:39 +01:00
### Public archive.
landing: Write up why open source projects should use Zulip This isn't very slick, but it should get the main points down, and it's past time we got something like this up. Definitely needs in the future another pass at the text, and also some images (screenshots, etc.) and styling.
2017-06-19 00:47:02 +02:00
portico: Update for/open-source.
2017-07-28 20:02:28 +02:00
Allow search engines to index your chat, with a read-only view of your
public streams. Zulip’s topic-based threading keeps conversations coherent
open source: Document some recent and upcoming features.
2019-09-12 19:18:30 +02:00
and organized, enabling a meaningful archive indexed by search engines.
Currently implemented as an [out-of-tree
for/open-source: Update the repo url of Zulip Archive.
2019-11-14 22:33:50 +01:00
tool](https://github.com/zulip/zulip-archive), though a native feature
open source: Document some recent and upcoming features.
2019-09-12 19:18:30 +02:00
built into the Zulip server is coming soon.
portico: Typographical nitpicking. Punctuate marketing headings with a period. Fix a couple of title-cased headings to sentense case. Consistently use curly apostrophes, curly quotation marks, and Unicode ellipses. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-18 00:09:39 +01:00
### Logged-out public access (coming soon).
open source: Document some recent and upcoming features.
2019-09-12 19:18:30 +02:00
open source: Add a more complete "why zulip" explanation. Also contains a lot of edits from Rishi, including to the content around Zulip's features and what to highlight there.
2019-09-12 21:45:16 +02:00
[Coming soon](https://github.com/zulip/zulip/issues/13172): Allow
portico: Typographical nitpicking. Punctuate marketing headings with a period. Fix a couple of title-cased headings to sentense case. Consistently use curly apostrophes, curly quotation marks, and Unicode ellipses. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-18 00:09:39 +01:00
users to read and search public stream history in Zulip’s UI without
open source: Add a more complete "why zulip" explanation. Also contains a lot of edits from Rishi, including to the content around Zulip's features and what to highlight there.
2019-09-12 21:45:16 +02:00
first creating an account.
open source: Document some recent and upcoming features.
2019-09-12 19:18:30 +02:00
portico: Typographical nitpicking. Punctuate marketing headings with a period. Fix a couple of title-cased headings to sentense case. Consistently use curly apostrophes, curly quotation marks, and Unicode ellipses. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-18 00:09:39 +01:00
### Quality data export.
open source: Add a more complete "why zulip" explanation. Also contains a lot of edits from Rishi, including to the content around Zulip's features and what to highlight there.
2019-09-12 21:45:16 +02:00
Our high quality [export](/help/export-your-organization) and
[import](https://zulip.readthedocs.io/en/latest/production/export-and-import.html)
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 23:04:39 +02:00
tools ensure you can always move from [Zulip Cloud](https://zulip.com)
hosting to your own servers.
open source: Document some recent and upcoming features.
2019-09-12 19:18:30 +02:00
portico: Typographical nitpicking. Punctuate marketing headings with a period. Fix a couple of title-cased headings to sentense case. Consistently use curly apostrophes, curly quotation marks, and Unicode ellipses. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-18 00:09:39 +01:00
### Free and open source.
open source: Document some recent and upcoming features.
2019-09-12 19:18:30 +02:00
open source: Add a more complete "why zulip" explanation. Also contains a lot of edits from Rishi, including to the content around Zulip's features and what to highlight there.
2019-09-12 21:45:16 +02:00
Unlike many modern "open source" applications that are actually Open
Core, Zulip is 100% Free and Open Source software. All code,
including for the [server](https://github.com/zulip/zulip),
[desktop](https://github.com/zulip/zulip-desktop),
[mobile](https://github.com/zulip/zulip-mobile), and beta
[terminal](https://github.com/zulip/zulip-terminal) apps is available
under the Apache 2 license.
We love helping other open source communities and prioritize feature
requests from open source communities the same way we prioritize
feature requests from paying customers.
portico: Typographical nitpicking. Punctuate marketing headings with a period. Fix a couple of title-cased headings to sentense case. Consistently use curly apostrophes, curly quotation marks, and Unicode ellipses. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-18 00:09:39 +01:00
So if there’s something we could improve to make Zulip the obvious
docs: Recommend contact page over email wherever possible. With a few tweaks from tabbott to preserve the enthusiasm for feedback and de-emphasize twitter as a channel (we give better support elsewhere).
2020-05-05 15:52:32 +02:00
choice either for you or your community, [contact
us](/help/contact-support) and we'll do what we can to help!
portico: Clean up /for/open-source. - Remove essay portion and link to /for/communities instead. - Copy over relevant quotes from /for/communities. - Move "Join the hundreds of open-source projects we sponsor."
2021-07-28 01:35:18 +02:00
> “I highly recommend Zulip to other communities. We’re coming from
> Freenode as our only real-time communication so the difference is
> night and day. Slack is a no-go for many due to not being FLOSS,
> and I’m concerned about vendor lock-in if they were to stop being
> so generous. Slack’s threading model is much worse than Zulip’s
> IMO. The streams/topics flow is an incredibly intuitive way to keep
> track of everything that is going on.”
> — RJ Ryan, Mixxx Developer
<script async src="https://platform.twitter.com/widgets.js"></script>