Skip to content

Commit

Permalink
docs: Replace IRC/Twitter/mailing list with Zulip
Browse files Browse the repository at this point in the history
  • Loading branch information
jodal committed Oct 15, 2019
1 parent 6ee0379 commit 3bd5fa0
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 44 deletions.
9 changes: 6 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,10 @@ To get started with Mopidy, check out
`the installation docs <http://docs.mopidy.com/en/latest/installation/>`_.

- `Documentation <https://docs.mopidy.com/>`_
- `Discussion forum <https://discourse.mopidy.com/>`_
- `Discourse forum <https://discourse.mopidy.com/>`_
- `Zulip chat <https://mopidy.zulipchat.com/>`_
- `Source code <https://github.com/mopidy/mopidy>`_
- `Issue tracker <https://github.com/mopidy/mopidy/issues>`_
- IRC: ``#mopidy`` at `irc.freenode.net <http://freenode.net/>`_
- Twitter: `@mopidy <https://twitter.com/mopidy/>`_

.. image:: https://img.shields.io/pypi/v/Mopidy.svg?style=flat
:target: https://pypi.python.org/pypi/Mopidy/
Expand All @@ -71,3 +70,7 @@ To get started with Mopidy, check out
.. image:: https://img.shields.io/codecov/c/github/mopidy/mopidy/develop.svg
:target: https://codecov.io/gh/mopidy/mopidy
:alt: Test coverage

.. image:: https://img.shields.io/badge/chat-on%20zulip-brightgreen
:target: https://mopidy.zulipchat.com/
:alt: Chat on Zulip
29 changes: 13 additions & 16 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,10 @@ Asking questions
Please get in touch with us in one of these ways when requesting help with
Mopidy and its extensions:

- Our discussion forum: `discourse.mopidy.com <https://discourse.mopidy.com>`_.
Just sign in and fire away.
- Our Discourse forum: `discourse.mopidy.com <https://discourse.mopidy.com>`_.

- Our IRC channel: `#mopidy <https://webchat.freenode.net/?channels=#mopidy>`_
on `irc.freenode.net <http://freenode.net>`_.
Be prepared to hang around for a while, as we're not always around to answer
straight away.
- The ``#mopidy-dev`` stream on Zulip chat: `mopidy.zulipchat.com
<https://mopidy.zulipchat.com>`_.

Before asking for help, it might be worth your time to read the
:ref:`troubleshooting` page, both so you might find a solution to your problem
Expand All @@ -32,13 +29,13 @@ Helping users
=============

If you want to contribute to Mopidy, a great place to start is by helping other
users on IRC and in the discussion forum. This is a contribution we value
highly. As more people help with user support, new users get faster and better
help. For your own benefit, you'll quickly learn what users find confusing,
difficult or lacking, giving you some ideas for where you may contribute
improvements, either to code or documentation. Lastly, this may also free up
time for other contributors to spend more time on fixing bugs or implementing
new features.
users in the discussion forum and the ``#mopidy-users`` Zulip stream. This is a
contribution we value highly. As more people help with user support, new users
get faster and better help. For your own benefit, you'll quickly learn what
users find confusing, difficult or lacking, giving you some ideas for where you
may contribute improvements, either to code or documentation. Lastly, this may
also free up time for other contributors to spend more time on fixing bugs or
implementing new features.


.. _issue-guidelines:
Expand Down Expand Up @@ -72,9 +69,9 @@ Pull request guidelines
- If it's a bug, :ref:`file an issue <issue-guidelines>`.

- If it's an enhancement, discuss it with other Mopidy developers first,
either in a GitHub issue, on the discussion forum, or on IRC. Making sure
your ideas and solutions are aligned with other contributors greatly
increases the odds of your pull request being quickly accepted.
either in a GitHub issue, on the discussion forum, or on Zulip chat.
Making sure your ideas and solutions are aligned with other contributors
greatly increases the odds of your pull request being quickly accepted.

#. Create a new branch, based on the ``develop`` branch, for every feature or
bug fix. Keep branches small and on topic, as that makes them far easier to
Expand Down
16 changes: 8 additions & 8 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,19 +58,19 @@ To get started with Mopidy, start by reading :ref:`installation`.

**Getting help**

If you get stuck, you can get help at the `Mopidy discussion forum
<https://discourse.mopidy.com/>`_. We also hang around at IRC on the
``#mopidy`` channel at `irc.freenode.net <http://freenode.net/>`_.
If you get stuck, you can get help at the our `Discourse forum
<https://discourse.mopidy.com/>`_ or in the ``#mopidy-users`` stream on `Zulip
chat <https://mopidy.zulipchat.com/>`_.

If you stumble into a bug or have a feature request, please create an issue in
the `issue tracker <https://github.com/mopidy/mopidy/issues>`_. If you're
unsure if it's a bug or not, ask for help in the forum or at IRC first. The
unsure if it's a bug or not, ask for help in the forum or the chat first. The
`source code <https://github.com/mopidy/mopidy>`_ may also be of help.

If you want to stay up to date on Mopidy developments, you can follow `@mopidy
<https://twitter.com/mopidy/>`_ on Twitter. There's also a `mailing list
<https://groups.google.com/forum/?fromgroups=#!forum/mopidy>`_ used for
announcements related to Mopidy and Mopidy extensions.
If you want to stay up to date on Mopidy developments, you can follow the
``#mopidy-dev`` stream on `Zulip chat <https://mopidy.zulipchat.com/>`__ or
watch out for announcements on the `Discourse forum
<https://discourse.mopidy.com/>`__.


.. toctree::
Expand Down
4 changes: 2 additions & 2 deletions docs/releasing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ Creating releases
#. Make sure the new tag is built by Read the Docs, and that the ``latest``
version shows the newly released version.

#. Spread the word through the topic on #mopidy on IRC, @mopidy on Twitter, and
on the mailing list.
#. Spread the word through an announcement post on the `Discourse forum
<https://discourse.mopidy.com/>`_.

#. Notify distribution packagers, including but not limited to: Debian, Arch
Linux, Homebrew.
22 changes: 7 additions & 15 deletions docs/troubleshooting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,19 @@
Troubleshooting
***************

If you run into problems with Mopidy, we usually hang around at ``#mopidy`` on
`irc.freenode.net <http://freenode.net/>`_ and also have a `discussion forum
<https://discourse.mopidy.com/c/mopidy>`_.
If you get stuck, you can get help at the our `Discourse forum
<https://discourse.mopidy.com/>`_ or in the ``#mopidy-users`` stream on `Zulip
chat <https://mopidy.zulipchat.com/>`_.

If you stumble into a bug or have a feature request, please create an issue in
the `issue tracker <https://github.com/mopidy/mopidy/issues>`_.
the `issue tracker <https://github.com/mopidy/mopidy/issues>`_. If you're
unsure if it's a bug or not, ask for help in the forum or the chat first. The
`source code <https://github.com/mopidy/mopidy>`_ may also be of help.

When you're debugging yourself or asking for help, there are some tools built
into Mopidy that you should know about.


Sharing config and log output
=============================

If you're getting help at IRC, we recommend that you use a pastebin, like
`pastebin.com <https://pastebin.com/>`_ or `GitHub Gist
<https://gist.github.com/>`_, to share your configuration and log output.
Pasting more than a couple of lines on IRC is generally frowned upon. On the
mailing list or when reporting an issue, somewhat longer text dumps are
accepted, but large logs should still be shared through a pastebin.


Show effective configuration
============================

Expand Down

0 comments on commit 3bd5fa0

Please sign in to comment.