rooms.md 5.84 KB
Newer Older
1 2 3 4
# Rooms

Rooms are part of a community.

5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
Rooms are also referred to as "troupes" internally in the codebase for legacy reasons.

All rooms have unlimited message history, public or private.


## People/Roster

You can see who is in the room and add/invite new users via the roster section in the right-toolbar

![](https://i.imgur.com/nW29SY1.png)

#### Eyeballs Disambiguation

Eyeballs are the green and yellow/orange dots on top of the avatars in the people section of a room. They represent the current status or online presence of a person in the room.

![](https://i.imgur.com/MRuIXK4.png)

So what does each color mean?

 - **Green**: Actively looking at the room
 - **Yellow/Orange**: Not actively looking at the room

"Actively looking" equates to whether the window has focus and the room is open.


30

Eric Eastwood's avatar
Eric Eastwood committed
31
## Room user
32

Eric Eastwood's avatar
Eric Eastwood committed
33 34 35 36 37 38
### Leave a room

You can leave a room via **Room settings dropdown** -> **Leave this room**

If you have mad skillz, you can also type "/leave" in the chat room (slash command).

39 40
It's not possible to leave a one to one room, only hide it(see below)

Eric Eastwood's avatar
Eric Eastwood committed
41 42 43
![](https://i.imgur.com/Rc4EVnV.png)


44 45 46 47 48 49 50 51 52
### Hide a room

You can hide a room via **Room settings dropdown** -> **Hide this room**

Hiding a room with keep it from appearing in your left-menu room list. If you receive a notification for the room again, it will reappear. If you no longer wish to receive notifications from that room, you should either leave that room (`/leave` slash command) or change notifications to mentions only. You cannot leave a one to one room.

![](https://i.imgur.com/ceIVTNd.png)


Eric Eastwood's avatar
Eric Eastwood committed
53 54 55
## Room admin

### Room creation
56

57
Use the **+** -> **Create room** option in the bottom-left of the menu bar to start the room creation process.
58

59
![](https://i.imgur.com/Mt6sMOe.png)
60

61
If you want to associate the room with a GitLab project or GitHub repo, just select it from the repo dropdown (make sure you are signed in respectively with GitLab or GitHub). If you don't see a GitHub repo listed in the dropdown, see the [FAQ](./faq.md#why-isnt-my-github-organisation-or-repos-appearing)
62

63
![](https://i.imgur.com/yOobB1g.png)
64

65

Eric Eastwood's avatar
Eric Eastwood committed
66
#### Why isn't my GitHub organisation or repos appearing?
67 68 69 70

See the [FAQ](./faq.md#why-isn-t-my-github-organisation-or-repos-appearing).


Eric Eastwood's avatar
Eric Eastwood committed
71
### Room security
72 73 74 75 76 77 78

**Public rooms**

 - A public room can be seen by everyone

**Private rooms**

79
 - A room connected to a private project/repo can be accessed by anyone with access to the project/repo.
80
 - A private room with no association can only be accessed if they are manually invited to the room.
81
 - A private room can also be associated with the community and anyone in the community can join the room. If the community was associated with an group/org, anyone in the group/org could join for example
82

83 84 85 86 87 88 89 90 91 92 93 94 95 96
#### Change room security after creation

It is currently not possible to adjust your room security (public/private) after creation,
but we can do it manually for you.

Send a message to [email protected] with the following info. Make sure to email with the primary email address associated with the GitLab/GitHub/Twitter account tied to your Gitter account.

 - Link to the room on Gitter
 - New desired public/private security or repo/org association
 - Some context behind the change

You can track https://gitlab.com/gitlab-org/gitter/webapp/issues/676 for progress on this issue.


97

98 99 100 101 102 103 104 105 106 107
### Room topic/description

A room topic/description will help the community members and new people joining to know what's the purpose of the room.

To set up your room topic, double-click on the area next to the room name in the chat header.

You can also use the `/topic <some topic message>` slash command to set the room topic.

![](https://i.imgur.com/ecdteoh.png)

108 109 110 111 112 113
### Room welcome message

You can set a room welcome message via **Room settings dropdown** -> **Settings** -> **Welcome message**. This message is only shown when joining a room and the user needs to click the "I understand" button before joining the room.

![](https://i.imgur.com/ujd8kHE.png) ![](https://i.imgur.com/06azySl.png) ![](https://i.imgur.com/Sou791K.png)

114

115 116 117 118 119 120 121 122 123 124
### Add a Gitter badge to your repo readme

During room creation, if you add a repo association, you will see a checkbox option **Send PR to add the Gitter badge to your README**, that will automagically have the [Gitter Badger bot](https://github.com/gitter-badger) send a pull request to add the Gitter badge.

If you missed that option during room creation, after the fact, you can go to the **Room settings dropdown** -> **Share this chat room** -> **README badge** and copy the markdown text to put in your own readme.
If your room is associated with a GitHub repo, you can use the **Send pull request** button to have the [Gitter Badger bot](https://github.com/gitter-badger) send a pull request with the badge markdown added.

![](https://i.imgur.com/LRwMqHk.png)


125 126 127 128 129 130
### Moderation

As an admin of the room, you can delete messages from other users.

You can add new admins for a room via **Room settings dropdown** -> **Permissions** modal

131

Eric Eastwood's avatar
Eric Eastwood committed
132
### Restrict room to GitHub users
133

134
You can restrict a room to GitHub users via **Room settings dropdown** -> **Settings** -> **Only GitHub users are allowed to join this room.** checkbox
135 136

![](https://i.imgur.com/ujd8kHE.png) ![](https://i.imgur.com/oOGoEYw.png)
137 138


Eric Eastwood's avatar
Eric Eastwood committed
139
### Rename a room
140 141 142 143 144 145 146 147 148

If you want to rename a room because a GitHub repo was renamed/transferred, see this [FAQ section instead](./faq.md#what-happens-if-i-rename-something-on-GitHub-org-repo) instead.

Currently, there isn't a way to rename a room in the UI. But you can send a message to [email protected] with the following info. Make sure to email with the primary email address associated with the GitLab/GitHub/Twitter account tied to your Gitter account.

 - Link to the current Gitter room
 - Desired room name


Eric Eastwood's avatar
Eric Eastwood committed
149
### Delete a room
150 151 152 153

If you are a room admin, you can delete a room via **Room settings dropdown** -> **Delete this room**

![](https://i.imgur.com/FqxWgsM.png)