Skip to content

Commit

Permalink
Add docs for communities
Browse files Browse the repository at this point in the history
  • Loading branch information
thibaultamartin committed Oct 25, 2022
1 parent 684b982 commit 974ea40
Show file tree
Hide file tree
Showing 14 changed files with 172 additions and 0 deletions.
148 changes: 148 additions & 0 deletions content/docs/communities/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
+++
title = "Communities"
weight = 200
template = "docs/index.html"
[extra]
emoji = "👪"
tile = "I want to use Matrix for my community or organisation"
updated = "2022-10-18T16:00:00Z"
+++

We strongly recommend getting familiar with Matrix as an individual. It's easy
to use and to get started, but the amount of clients and providers in the wild
can make things overwhelming for newcomers. Follow [the users documentation](/docs/users)
to get started using Matrix as an individual.

For this tutorial we're going to assume your provider (homeserver) is
Matrix.org. You will see later that Matrix's flexibility allows you to start a
community on Matrix.org and then move to another provider if you want. You can
also bridge your existing community to Matrix to progressively migrate people
without a traumatic big platform switch.

Here are a couple of screenshots to see how a thriving community can look like
on Matrix.

* TODO: Space overview
* TODO: Room in a Space
* TODO: Split view Matrix/Discord

We recommend you to set up a dummy community to play around first, and then you
can move on creating your full community and/or bridging your existing one to
Matrix.

The first thing to do whether you are starting a new community or trying to
bridge one to Matrix is to create a Space for it. You can think of Matrix Spaces
as equivalents of Slack Workspaces, or Discord Servers. They're a way to group
people and rooms.

## Creating & sharing a Space

Click on the + on the leftmost column of Element to create a new Space

![](space-click-plus.png)

In this example, we're creating a public space for people who enjoy warm drinks.

![](space-public-private.png)

You can add a picture, name and description for your Space to be easier to find
and for people to have a good idea about what's happening in your community.

![](space-details.png)

Note there's also an address field. The address of your Space consists of a name
(sometimes called the local part) and of the domain of your provider. Here the
provider domain is `matrix.org` because we're creating the space from an account
that was created on Matrix.org

People can join your Space if it's public and you give them the address, which
is much easier to jot down or to memorise than a full [matrix.to](https://matrix.to)
link!

Later if you decide to deploy your own provider or to rent one as a service
(see [the list of providers we're aware of](/ecosystem/hosting) for more
details), you will be able to add new adresses to this Space and change the main
one.

You can then add a couple of rooms to get started with the basics... and voilà,
you now have a community on Matrix!

## Adding rooms

You can play around in the rooms, but look! We forgot to create a room for
people who enjoy hot cocoas! Click on the Space avatar in the left bar to go to
the Space's index

![](space-click-avatar.png)

From there you can see the list of all the rooms in your Space. The rooms you
see in the left panel are the rooms you are a member of, and the rooms you see
in the main panel are all the rooms in your Space. Since you're the
administrator of the Space they're the same to you, but that will not
necessarily be the case for new joiners.

Clici on "Add" then on "New room" to create the room for hot cocoa drinkers.

![](space-add-room-menu.png)

Here again, you can give the room a name, a description, an address, and make it
public or private.

![](space-add-room-details.png)

Note that you can create a private room in a public Space. People who are not
members of this room will not see it in the Space index, and people who are
member of this room will see it in their room list when they're in this Space.
There's a third mode: visible to members of the Space. You can change the room
visibility at any point in the room settings.

## History visibility

The room visibility is not the only important parameter in a room. You can also
change the _history_ visibility so people can either:
- Not see what was said in this room before they joined
- See what happened since the option was selected
- See what happened since they were invited in the room
- See what happened since they joined

To change this setting, click on the `i` on the top right, then on "Room
settings"

![](room-settings-right-bar.png)

Alternatively you can click on the room name in the header and click on
"Settings"

![](room-settings-header.png)

Finally head to the "Security & Privacy" tab

![](room-security-privacy.png)

There is no best practice here, it depends entirely on your preferences and what
you want for your community.

## Basic Moderation

For a good overview of what are roles, power levels, redactions, and how to keep
a group safe at the room level, please head to
[the group chat documentation](/docs/users/desktop/private-group-chat#keeping-the-group-safe).

## Advanced moderation

Basic moderation is enough for small groups, but it tends not to scale too well
as the number of people and rooms in a community grow.

* Mjolnir
* Mjolnir for all?

## Moving to another provider

* Why?
* Branding
* Recovering accounts and/or rooms
* Staying in control of where your data is
* Adding more, less crowded bridges
* How?
* Relying on a [hosting provider](/ecosystem/hosting)
* Hosting one of [the server implementations](/ecosystem/servers) yourself
8 changes: 8 additions & 0 deletions content/docs/communities/bridge-discord/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
+++
title = "Bridging my Discord community"
weight = 200
[extra]
emoji = "🌉"
tile = "I want to bridge my Discord community to Matrix"
last_updated = "2022-10-18T16:00:00Z"
+++
8 changes: 8 additions & 0 deletions content/docs/communities/bridge-irc/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
+++
title = "Bridging my IRC community"
weight = 300
[extra]
emoji = "🌉"
tile = "I want to bridge my IRC community to Matrix"
last_updated = "2022-10-18T16:00:00Z"
+++
8 changes: 8 additions & 0 deletions content/docs/communities/bridge-slack/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
+++
title = "Bridging my Slack community"
weight = 100
[extra]
emoji = "🌉"
tile = "I want to bridge my Slack community to Matrix"
last_updated = "2022-10-18T16:00:00Z"
+++
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/docs/communities/space-add-room-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/docs/communities/space-click-avatar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/docs/communities/space-click-plus.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/docs/communities/space-create-rooms.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/docs/communities/space-details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 974ea40

Please sign in to comment.