Skip to content
This repository has been archived by the owner on Mar 17, 2023. It is now read-only.

Commit

Permalink
add more folders
Browse files Browse the repository at this point in the history
also fix links and remove order metadata
  • Loading branch information
MartinSchoeler committed Dec 5, 2017
1 parent d56b92d commit 77892c9
Show file tree
Hide file tree
Showing 160 changed files with 267 additions and 707 deletions.
4 changes: 2 additions & 2 deletions administrator-guides/file-upload/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
There are several choices for file Storage

- GridFS
- [Amazon S3](Amazon-s3.md)
- [Minio | selfhosted s3 compatible object storage](Minio.md)
- [Amazon S3](amazon-s3/)
- [Minio | selfhosted s3 compatible object storage](minio/)
- Local file system

To change the system that you want to use from the default GridFS select the option from the "Storage Type" section.
4 changes: 0 additions & 4 deletions developer-guides/branches-and-releases/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
order: 2
---

## Rocket.Chat Workflow

1. Start working on an issue you’re assigned to. If you’re not assigned to any issue, find the issue with the highest priority you can work on, by relevant label and assign it to yourself. Priority is given by milestones. You should always check issues in the current milestone, then short-term, middle-term and long-term in that order.
Expand Down
6 changes: 1 addition & 5 deletions developer-guides/code-styleguide/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
order: 4
---

# Rocket.Chat Code Styleguide

- [Less Code Styleguide](less.md)
- [Less Code Styleguide](less/)
12 changes: 4 additions & 8 deletions developer-guides/iframe-integration/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
---
order: 9
---

# Iframe Integration

## Use your own login page to login users in Rocket.Chat
If you want to authenticate users using the iframe integration, go to `Adminstration > Accounts > Iframe` and enable it:
- [How to use iframe integration for authentication](Authentication)
If you want to authenticate users using the iframe integration, go to `Adminstration > Accounts > Iframe` and enable it:
- [How to use iframe integration for authentication](Authentication/)

## Use Rocket.Chat in your site/app inside an iframe
If you need listen to events, go to `Administration > General > Iframe Integration` and enable send (events) or receive (commands), depending on your needs:
- [How to use iframe integration events](Events)
- [How to use iframe integration commands](Commands)
- [How to use iframe integration events](Events/)
- [How to use iframe integration commands](Commands/)
4 changes: 0 additions & 4 deletions developer-guides/internationalization/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1 @@
---
order: 7
---

# Internationalization (i18n)
4 changes: 0 additions & 4 deletions developer-guides/livechat-api/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
order: 5
---

# Livechat API

## Usage
Expand Down
4 changes: 0 additions & 4 deletions developer-guides/mobile-apps/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
order: 8
---

# Building Rocket.Chat for mobile apps

## Android
Expand Down
4 changes: 0 additions & 4 deletions developer-guides/realtime-api/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
order: 10
---

# Realtime API

__IMPORTANT!__ These docs are based on an unreleased version of the API. If you want to try it out, point your client to __wss://open.rocket.chat/websocket__.
Expand Down
8 changes: 4 additions & 4 deletions developer-guides/realtime-api/livechat-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This API is intended to be used for having a livechat conversation;


- First of all you need to generate a visitor token (any random string);
- Call [livechat:getInitialData](getinitialData.md) passing `visitorToken` as first argument, the response will be an object containing a livechat [configuration object](getinitialData.md#response) with following properties:
- Call [livechat:getInitialData](getinitialData/) passing `visitorToken` as first argument, the response will be an object containing a livechat [configuration object](getinitialData/#response) with following properties:

| Field | Type | Description |
| :--- | :--- | :--- |
Expand All @@ -16,9 +16,9 @@ This API is intended to be used for having a livechat conversation;
| `triggers` | `Array` | Array of livechat triggers. |
| `departments` | `Array` | Array of livechat departments. |

- Call [livechat:registerGuest](registerguest.md) to register user;
- With the response of [livechat:registerGuest](registerguest.md) you should call [login method](../method-calls/login/) passing the response token;
- Call [livechat:registerGuest](registerguest/) to register user;
- With the response of [livechat:registerGuest](registerguest/) you should call [login method](../method-calls/login/) passing the response token;
- Before sending the first message you have to generate a random `room _id`;
- Now you can send messages to method [sendMessageLivechat](sendMessagelivechat.md)
- Now you can send messages to method [sendMessageLivechat](sendMessagelivechat/)
- Subscribe to: [stream-room-messages](../subscriptions/stream-room-messages/) and `stream-livechat-room`
- Get agent info by calling `livechat:getAgentData`
6 changes: 1 addition & 5 deletions developer-guides/realtime-api/method-calls/logout/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
---
order: 2
---

# Logout

## See Also
* [Login][1]

[1]:../login
[1]:../login/
22 changes: 9 additions & 13 deletions developer-guides/rest-api/Chat/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
---
order: 50
---

# Chat Methods
| Url | Short Description | Details Page |
| :--- | :--- | :--- |
| `/api/v1/chat.delete` | Deletes an existing chat message. | [Link](delete.md) |
| `/api/v1/chat.getMessage` | Retrieves a single chat message. | [Link](getMessage.md) |
| `/api/v1/chat.pinMessage` | Pins a chat message to the message's channel. | [Link](pinMessage.md) |
| `/api/v1/chat.postMessage` | Posts a new chat message. | [Link](postMessage.md) |
| `/api/v1/chat.react` | Sets/unsets the user's reaction to an existing chat message. | [Link](react.md) |
| `/api/v1/chat.starMessage` | Stars a chat message for the authenticated user. | [Link](starMessage.md) |
| `/api/v1/chat.unPinMessage` | Removes the pinned status of the provided chat message. | [Link](unPinMessage.md) |
| `/api/v1/chat.unStarMessage` | Removes the star on the chat message for the authenticated user. | [Link](unStarMessage.md) |
| `/api/v1/chat.update` | Updates the text of the chat message. | [Link](update.md) |
| `/api/v1/chat.delete` | Deletes an existing chat message. | [Link](delete/) |
| `/api/v1/chat.getMessage` | Retrieves a single chat message. | [Link](getMessage/) |
| `/api/v1/chat.pinMessage` | Pins a chat message to the message's channel. | [Link](pinMessage/) |
| `/api/v1/chat.postMessage` | Posts a new chat message. | [Link](postMessage/) |
| `/api/v1/chat.react` | Sets/unsets the user's reaction to an existing chat message. | [Link](react/) |
| `/api/v1/chat.starMessage` | Stars a chat message for the authenticated user. | [Link](starMessage/) |
| `/api/v1/chat.unPinMessage` | Removes the pinned status of the provided chat message. | [Link](unPinMessage/) |
| `/api/v1/chat.unStarMessage` | Removes the star on the chat message for the authenticated user. | [Link](unStarMessage/) |
| `/api/v1/chat.update` | Updates the text of the chat message. | [Link](update/) |
4 changes: 0 additions & 4 deletions developer-guides/rest-api/Chat/delete/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
order: 10
---

# Chat Message Delete
| URL | Requires Auth | HTTP Method |
| :--- | :--- | :--- | :--- |
Expand Down
4 changes: 0 additions & 4 deletions developer-guides/rest-api/Chat/getmessage/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
order: 20
---

# Get a Single Chat Message
Retrieves a single chat message by the provided id. Callee must have permission to access the room where the message resides.

Expand Down
4 changes: 0 additions & 4 deletions developer-guides/rest-api/Chat/pinmessage/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
order: 40
---

# Pins a Chat Message
Pins a chat message to the message's channel.

Expand Down
8 changes: 2 additions & 6 deletions developer-guides/rest-api/Chat/postmessage/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
order: 50
---

# Post a chat message
| URL | Requires Auth | HTTP Method |
| :--- | :--- | :--- | :--- |
Expand All @@ -27,14 +23,14 @@ The attachments is an array of objects with any of the following properties. One
* Image
* Audio
* Video
* Table/Fields
* Table/Fields

| Property | Example | Section | Description |
| :--- | :--- | :--- | :--- |
| `color` | `#ff0000` | General | The color you want the order on the left side to be, any value [background-css](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) supports. |
| `text` | `Sample attachment text` | General | The text to display for this attachment, it is different than the message's text. |
| `ts` | `2016-12-09T16:53:06.761Z` | General | Displays the time next to the `text` portion. |
| `thumb_url` | `https://site.com/img.png` | General | An image that displays to the left of the `text`, looks better when this is relatively small. |
| `thumb_url` | `https://site.com/img.png` | General | An image that displays to the left of the `text`, looks better when this is relatively small. |
| `message_link` | `https://rocket.chat` | General | Only applicable if the `ts` is provided, as it makes the time clickable to this link. |
| `collapsed` | `false` | General | Causes the image, audio, and video sections to be hidding when collapsed is true. |
| `author_name` | `Bradley Hilton` | Author | Name of the author. |
Expand Down
4 changes: 0 additions & 4 deletions developer-guides/rest-api/Chat/react/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
order: 60
---

# Chat Message Reactions
Toggles the authenciated user's reaction to the provided message.

Expand Down
4 changes: 0 additions & 4 deletions developer-guides/rest-api/Chat/starmessage/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
order: 70
---

# Star a Chat Message
Stars a chat message for the authenticated user.

Expand Down
4 changes: 0 additions & 4 deletions developer-guides/rest-api/Chat/unpinmessage/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
order: 80
---

# Unpins a Chat Message
Removes the pinned status of the provided chat message.

Expand Down
4 changes: 0 additions & 4 deletions developer-guides/rest-api/Chat/unstarmessage/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
order: 85
---

# Unpins a Chat Message
Removes the star on the chat message for the authenticated user.

Expand Down
4 changes: 0 additions & 4 deletions developer-guides/rest-api/Chat/update/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
order: 100
---

# Chat Message Update
| URL | Requires Auth | HTTP Method |
| :--- | :--- | :--- | :--- |
Expand Down
50 changes: 23 additions & 27 deletions developer-guides/rest-api/Groups/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,26 @@
---
order: 40
---

# Group Methods
| Url | Short Description | Details Page |
| :--- | :--- | :--- |
| `/api/v1/groups.addAll` | Adds all of the users on the server to a private group. | [Link](addAll.md) |
| `/api/v1/groups.addModerator` | Gives the role of moderator to a user in a group. | [Link](addModerator.md) |
| `/api/v1/groups.addOwner` | Gives the role of owner to a user in a group. | [Link](addOwner.md) |
| `/api/v1/groups.archive` | Archives a private group. | [Link](archive.md) |
| `/api/v1/groups.close` | Removes a private group from the list of groups. | [Link](close.md) |
| `/api/v1/groups.create` | Creates a new private group. | [Link](create.md) |
| `/api/v1/groups.getIntegrations` | Gets the integrations assigned to the group. | [Link](getIntegrations.md) |
| `/api/v1/groups.history` | Retrieves the messages from a private group. | [Link](history.md) |
| `/api/v1/groups.info` | Gets the information about a private group. | [Link](info.md) |
| `/api/v1/groups.invite` | Adds a user to the private group. | [Link](invite.md) |
| `/api/v1/groups.kick` | Removes a user from a private group. | [Link](kick.md) |
| `/api/v1/groups.leave` | Removes the calling user from the private group. | [Link](leave.md) |
| `/api/v1/groups.list` | List the private groups the caller is part of. | [Link](list.md) |
| `/api/v1/groups.open` | Adds the private group back to the list of groups. | [Link](open.md) |
| `/api/v1/groups.removeModerator` | Removes the role of moderator from a user in a group. | [Link](removeModerator.md) |
| `/api/v1/groups.removeOwner` | Removes the role of owner from a user in a group. | [Link](removeOwner.md) |
| `/api/v1/groups.rename` | Changes the name of the private group. | [Link](rename.md) |
| `/api/v1/groups.setDescription` | Sets a private group's description. | [Link](setDescription.md) |
| `/api/v1/groups.setPurpose` | Sets a private group's description. | [Link](setPurpose.md) |
| `/api/v1/groups.setReadOnly` | Sets whether the room is read only or not. | [Link](setReadOnly.md) |
| `/api/v1/groups.setTopic` | Sets a private group's topic. | [Link](setTopic.md) |
| `/api/v1/groups.setType` | Sets the type of room this group will be. | [Link](setType.md) |
| `/api/v1/groups.unarchive` | Unarchives a private group. | [Link](unarchive.md) |
| `/api/v1/groups.addAll` | Adds all of the users on the server to a private group. | [Link](addAll/) |
| `/api/v1/groups.addModerator` | Gives the role of moderator to a user in a group. | [Link](addModerator/) |
| `/api/v1/groups.addOwner` | Gives the role of owner to a user in a group. | [Link](addOwner/) |
| `/api/v1/groups.archive` | Archives a private group. | [Link](archive/) |
| `/api/v1/groups.close` | Removes a private group from the list of groups. | [Link](close/) |
| `/api/v1/groups.create` | Creates a new private group. | [Link](create/) |
| `/api/v1/groups.getIntegrations` | Gets the integrations assigned to the group. | [Link](getIntegrations/) |
| `/api/v1/groups.history` | Retrieves the messages from a private group. | [Link](history/) |
| `/api/v1/groups.info` | Gets the information about a private group. | [Link](info/) |
| `/api/v1/groups.invite` | Adds a user to the private group. | [Link](invite/) |
| `/api/v1/groups.kick` | Removes a user from a private group. | [Link](kick/) |
| `/api/v1/groups.leave` | Removes the calling user from the private group. | [Link](leave/) |
| `/api/v1/groups.list` | List the private groups the caller is part of. | [Link](list/) |
| `/api/v1/groups.open` | Adds the private group back to the list of groups. | [Link](open/) |
| `/api/v1/groups.removeModerator` | Removes the role of moderator from a user in a group. | [Link](removeModerator/) |
| `/api/v1/groups.removeOwner` | Removes the role of owner from a user in a group. | [Link](removeOwner/) |
| `/api/v1/groups.rename` | Changes the name of the private group. | [Link](rename/) |
| `/api/v1/groups.setDescription` | Sets a private group's description. | [Link](setDescription/) |
| `/api/v1/groups.setPurpose` | Sets a private group's description. | [Link](setPurpose/) |
| `/api/v1/groups.setReadOnly` | Sets whether the room is read only or not. | [Link](setReadOnly/) |
| `/api/v1/groups.setTopic` | Sets a private group's topic. | [Link](setTopic/) |
| `/api/v1/groups.setType` | Sets the type of room this group will be. | [Link](setType/) |
| `/api/v1/groups.unarchive` | Unarchives a private group. | [Link](unarchive/) |
4 changes: 0 additions & 4 deletions developer-guides/rest-api/Groups/addall/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
order: 1
---

# Group Add All
Adds all of the users of the Rocket.Chat server to the group.

Expand Down
4 changes: 0 additions & 4 deletions developer-guides/rest-api/Groups/addmoderator/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
order: 3
---

# Group Add Moderator
Gives the role of moderator for a user in the currrent group.

Expand Down
4 changes: 0 additions & 4 deletions developer-guides/rest-api/Groups/addowner/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
order: 4
---

# Group Add Owner
Gives the role of owner for a user in the currrent group.

Expand Down
6 changes: 1 addition & 5 deletions developer-guides/rest-api/Groups/archive/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
---
order: 5
---

# Group Archive
# Group Archive
Archives a private group, only if you're part of the group.

| URL | Requires Auth | HTTP Method |
Expand Down
4 changes: 0 additions & 4 deletions developer-guides/rest-api/Groups/close/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
order: 10
---

# Group Close
Removes the private group from the user's list of groups, only if you're part of the group.

Expand Down
4 changes: 0 additions & 4 deletions developer-guides/rest-api/Groups/create/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
order: 15
---

# Group Create
Creates a new private group, optionally including specified users. The group creator is always included.

Expand Down
6 changes: 1 addition & 5 deletions developer-guides/rest-api/Groups/getintegrations/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
---
order: 17
---

# Get Integrations
Retrieves the integrations which the group has, requires the permission `manage-integrations`. It supports the [Offset, Count, and Sort Query Parameters](../offset-and-count-and-sort-info.md) along with [Query and Fields Query Parameters](../query-and-fields-info.md).
Retrieves the integrations which the group has, requires the permission `manage-integrations`. It supports the [Offset, Count, and Sort Query Parameters](../../offset-and-count-and-sort-info/) along with [Query and Fields Query Parameters](../../query-and-fields-info/).

| URL | Requires Auth | HTTP Method |
| :--- | :--- | :--- |
Expand Down
4 changes: 0 additions & 4 deletions developer-guides/rest-api/Groups/history/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
order: 20
---

# Group History
Retrieves the messages from a private group, only if you're part of the group.

Expand Down
4 changes: 0 additions & 4 deletions developer-guides/rest-api/Groups/info/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
order: 25
---

# Group Info
Retrieves the information about the private group, only if you're part of the group.

Expand Down
4 changes: 0 additions & 4 deletions developer-guides/rest-api/Groups/invite/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
order: 30
---

# Group Invite
Adds a user to the private group.

Expand Down
4 changes: 0 additions & 4 deletions developer-guides/rest-api/Groups/kick/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
order: 35
---

# Group Kick
Removes a user from the private group.

Expand Down
4 changes: 0 additions & 4 deletions developer-guides/rest-api/Groups/leave/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
order: 40
---

# Group Leave
Causes the callee to be removed from the private group, if they're part of it and are not the last owner.

Expand Down
6 changes: 1 addition & 5 deletions developer-guides/rest-api/Groups/list/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
---
order: 45
---

# Group List
Lists all of the private groups the calling user has joined. It supports the [Offset, Count, and Sort Query Parameters](../offset-and-count-and-sort-info.md) along with just the [Fields Query Parameters](../query-and-fields-info.md).
Lists all of the private groups the calling user has joined. It supports the [Offset, Count, and Sort Query Parameters](../../offset-and-count-and-sort-info/) along with just the [Fields Query Parameters](../../query-and-fields-info/).

| URL | Requires Auth | HTTP Method |
| :--- | :--- | :--- |
Expand Down
4 changes: 0 additions & 4 deletions developer-guides/rest-api/Groups/open/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
order: 50
---

# Group Open
Adds the private group back to the user's list of private groups.

Expand Down
Loading

0 comments on commit 77892c9

Please sign in to comment.