From eb30ca49e2721ac1422092ddea20dd7f25d33545 Mon Sep 17 00:00:00 2001 From: Dan Caseley Date: Tue, 19 May 2020 18:42:44 +0100 Subject: [PATCH 1/2] Fix build - fix broken links --- _config.yml | 2 + _data/projects.yml | 42 +++++++++---------- contributing/developing.md | 2 +- .../paas-deployments/digital-ocean.md | 2 +- 4 files changed, 25 insertions(+), 23 deletions(-) diff --git a/_config.yml b/_config.yml index cebc072ecf..9edef05b51 100644 --- a/_config.yml +++ b/_config.yml @@ -26,6 +26,8 @@ whitelist: - jekyll-redirect-from markdown: kramdown highlighter: rouge +include: +- .gitbook exclude: - Gemfile - Gemfile.lock diff --git a/_data/projects.yml b/_data/projects.yml index e7c1ba29b5..bf8971adb5 100644 --- a/_data/projects.yml +++ b/_data/projects.yml @@ -4,13 +4,13 @@ description: Guides for the basic usage of Rocket.Chat. path: user-guides/ pages: - Connecting to a Server: connecting-to-a-server/ - Registration: registration/ - Channels: channels/ - Direct messages between multiple users: direct-messages-between-multiple-users/ - Messaging: messaging/ - Managing your Account: managing-your-account/ - Talking to users from another server: talking-to-users-from-another-server/ + Connecting to a Server: connecting-to-a-server.html + Registration: registration.html + Channels: channels.html + Direct messages between multiple users: direct-messages-between-multiple-users.html + Messaging: messaging.html + Managing your Account: managing-your-account.html + Talking to users from another server: talking-to-users-from-another-server.html - name: Installation Guides @@ -18,7 +18,7 @@ description: Guides for installing and deploying Rocket.Chat path: installation/ pages: - Cloud: rocket-chat-cloud/ + Cloud: rocket-chat-cloud.html PaaS Deployments: paas-deployments/ Docker Containers: docker-containers/ Manual Installation: manual-installation/ @@ -31,10 +31,10 @@ description: Guides for managing and configuring Rocket.Chat path: administrator-guides/ pages: - Account Settings: account-settings/ + Account Settings: account-settings.html Email: email/ - Federation: federation/ - Permissions: permissions/ + Federation: federation.html + Permissions: permissions.html Livechat: livechat/ File Upload: file-upload/ Integrations: integrations/ @@ -46,18 +46,18 @@ description: Guides for developing and modifying Rocket.Chat's code path: developer-guides/ pages: - Quick Start: quick-start/ - Branches and Releases: branches-and-releases/ - Testing: testing/ + Quick Start: quick-start.html + Branches and Releases: branches-and-releases.html + Testing: testing.html Rest API: rest-api/ Realtime API: realtime-api/ - Livechat API: livechat-api/ + Livechat API: livechat-api.html - name: Security icon: install.svg description: Security documentation - path: security/ + path: security.html pages: - @@ -66,9 +66,9 @@ description: Guides for using bots in Rocket.Chat path: bots/ pages: - Bots Architecture: bots-architecture/ + Bots Architecture: bots-architecture.html Create a Bot: create-and-run-a-bot/ - Configuring Bots: configure-bot-environment/ + Configuring Bots: configure-bot-environment.html - name: Contributing @@ -77,16 +77,16 @@ path: contributing/ pages: Developing: developing/ - Reporting Issues: reporting-issues/ + Reporting Issues: reporting-issues.html Documentation: documentation/ Security: security/ - Translating: translating/ + Translating: translating.html - name: Getting Support icon: getting-support.svg description: Guides getting support for Rocket.Chat - path: getting-support/ + path: getting-support.html - name: Android diff --git a/contributing/developing.md b/contributing/developing.md index 7f65ea9add..3c0e585002 100644 --- a/contributing/developing.md +++ b/contributing/developing.md @@ -23,7 +23,7 @@ But that doesn't mean you can't contribute! Every issue is open and any help is Want a simple task to get you started? [We maintain a list of those](https://github.com/RocketChat/Rocket.Chat/labels/contrib%3A%20easy)! Or just search for issues tagged contrib:easy -Check our [developer guides](../developer-guides/) for more detailed information about pull requests, workflow and API docs. +Check our [developer guides](../../developer-guides/) for more detailed information about pull requests, workflow and API docs. ## Priority Features and/or Bug fixes diff --git a/installation/paas-deployments/digital-ocean.md b/installation/paas-deployments/digital-ocean.md index 25df7ef3df..9beb2098d9 100644 --- a/installation/paas-deployments/digital-ocean.md +++ b/installation/paas-deployments/digital-ocean.md @@ -44,7 +44,7 @@ Replace email, HipChat & Slack with the ultimate team chat software solution. Need some help? Join our community forums https://forums.rocket.chat ``` -Besides the recommended setup you can out of the box access Rocket.Chat server at: [http://Droplet-IP:3000](http://Droplet-IP:3000>) +Besides the recommended setup you can out of the box access Rocket.Chat server at: [http://Droplet-IP:3000](http://Droplet-IP:3000) ## Setting up HTTPS From a2132b033a5d9a3c834b33719437855d296eaa20 Mon Sep 17 00:00:00 2001 From: Dan Caseley Date: Wed, 20 May 2020 15:24:07 +0100 Subject: [PATCH 2/2] Fix build - linting all the things --- administrator-guides/account-settings.md | 6 +- administrator-guides/federation.md | 18 +- .../rocket-chat-apps/bamboo-integration.md | 14 +- .../white-labeling/basic-white-labeling.md | 7 +- contributing/developing.md | 1 - .../documentation/contribution-guidelines.md | 10 +- .../documentation/documentation-map.md | 983 +++++++++--------- contributing/google-season-of-docs-2019.md | 1 - contributing/google-summer-of-code-2017.md | 5 +- contributing/google-summer-of-code-2018.md | 42 +- contributing/google-summer-of-code-2020.md | 13 +- developer-guides/code-styleguide/less.md | 165 ++- .../rest-api/authentication/login.md | 9 +- .../rest-api/query-and-fields-info.md | 3 +- developer-guides/rest-api/settings/update.md | 2 +- .../rest-api/users/createtoken.md | 2 +- developer-guides/ui-and-theming/components.md | 16 +- developer-guides/ui-and-theming/themes.md | 6 +- installation/automation-tools/ansible.md | 8 +- .../opensuse.md | 14 +- .../windows-server.md | 10 +- .../manual-installation/mongo-versions.md | 4 +- user-guides/managing-your-account.md | 16 +- user-guides/messaging.md | 3 +- 24 files changed, 672 insertions(+), 686 deletions(-) diff --git a/administrator-guides/account-settings.md b/administrator-guides/account-settings.md index 7c89f1a06d..8e6fb1d55c 100644 --- a/administrator-guides/account-settings.md +++ b/administrator-guides/account-settings.md @@ -92,9 +92,9 @@ The various settings that fall under this have simple descriptions for understan * **Use Default Blocked Domains List**: Will block the email domains listed on this [file](https://github.com/RocketChat/Rocket.Chat/blob/develop/packages/rocketchat-lib/server/lib/defaultBlockedDomainsList.js) * **Use DNS Domain Check**: When this is set to true, users won't be able to register with invalid domains. * **Registration Form**: This will change how the registration form is presented. Currently, there are 3 options: - * Public: The form will be public and anyone will be able to access; - * Disabled: The form will be disabled and users won't be able to register through it; - * Secret URL: The form will be only accessible using a specific URL; + * Public: The form will be public and anyone will be able to access; + * Disabled: The form will be disabled and users won't be able to register through it; + * Secret URL: The form will be only accessible using a specific URL; * **Registration Form Secret URL**: String to be added to the secret URL. Is recommended to use a random string for that. Example: `https://open.rocket.chat/register/[secret_hash]`. * **Invite URL Type**: URL type can either be direct or through a proxy. * **Registration Form Link Replacement Text**: Text to be shown in place of the registration form when the registration form is disabled. diff --git a/administrator-guides/federation.md b/administrator-guides/federation.md index 111f54419a..e1eab24ee7 100644 --- a/administrator-guides/federation.md +++ b/administrator-guides/federation.md @@ -11,16 +11,16 @@ When enabling federation on your server, your server becomes part of the Rocket. ## Features * **Current** - * Invite users from remote servers - * Direct chats between servers - * Public, private and broadcast rooms with remote users from any number of servers - * Read receipts, notifications and alerts distributed to remote servers - * Mute/Unmute remote users - * Share files among servers + * Invite users from remote servers + * Direct chats between servers + * Public, private and broadcast rooms with remote users from any number of servers + * Read receipts, notifications and alerts distributed to remote servers + * Mute/Unmute remote users + * Share files among servers * **Confirmed Next Features** - * Encrypted rooms - * Whitelist servers to communicate with - * Better federation set-up process, with helpers to validate the configuration + * Encrypted rooms + * Whitelist servers to communicate with + * Better federation set-up process, with helpers to validate the configuration ## Configuration diff --git a/administrator-guides/rocket-chat-apps/bamboo-integration.md b/administrator-guides/rocket-chat-apps/bamboo-integration.md index 355a2dcccd..a13229ce2d 100644 --- a/administrator-guides/rocket-chat-apps/bamboo-integration.md +++ b/administrator-guides/rocket-chat-apps/bamboo-integration.md @@ -26,13 +26,13 @@ After that, your Rocket.Chat will start receiving the configured notifications. > **Note**: Not all Build/Deployment events are supported by the Bamboo Integration at the time of this writing. Unsupported events will not result in any notification sent in Rocket.Chat. The list of supported events is as follows: * Plans: - * All Builds Completed - * Failed Builds and First Successful + * All Builds Completed + * Failed Builds and First Successful * Jobs: - * All Jobs Completed - * Failed Jobs and First Successful - * Job Error + * All Jobs Completed + * Failed Jobs and First Successful + * Job Error * Deployments: - * Deployment Started and Finished - * Deployment Failed + * Deployment Started and Finished + * Deployment Failed diff --git a/administrator-guides/white-labeling/basic-white-labeling.md b/administrator-guides/white-labeling/basic-white-labeling.md index e263c67713..c71968b674 100644 --- a/administrator-guides/white-labeling/basic-white-labeling.md +++ b/administrator-guides/white-labeling/basic-white-labeling.md @@ -454,10 +454,10 @@ Unread Counter Style: Here you will be able to change most of the logos on your server. Found in the administration menu. * logo \(svg, png, jpg\) - * Changes the logo on the footer of the left sidebar - * Changes the logo on the login page + * Changes the logo on the footer of the left sidebar + * Changes the logo on the login page * login background \(svg, png, jpg\) - * Changes the background of the login page + * Changes the background of the login page The next items are mostly icons for different operational systems and platforms, we recommend using the same image with the specified size and format on each item: Favicons are used in the browser tabs and as the icon for the server on the desktop application: @@ -487,4 +487,3 @@ Tiles on Microsoft Windows 10 start menu: Safari pinned tab Icon: * safari pinned tab \(svg\) - diff --git a/contributing/developing.md b/contributing/developing.md index 3c0e585002..0241e6846e 100644 --- a/contributing/developing.md +++ b/contributing/developing.md @@ -31,4 +31,3 @@ If you want a feature or bug fix to be developed with a higher priority: * [Contact us directly](https://rocket.chat/contact) to sponsor it's development * [Add a bounty](https://www.bountysource.com/teams/rocketchat) to it - diff --git a/contributing/documentation/contribution-guidelines.md b/contributing/documentation/contribution-guidelines.md index 76b2d35513..9b1e848265 100644 --- a/contributing/documentation/contribution-guidelines.md +++ b/contributing/documentation/contribution-guidelines.md @@ -29,9 +29,9 @@ When you create a new pull request, we expect some requirements to be met. * Whenever you add a new article or complete a incomplete article, please update the [Documentation Map](documentation-map.md) and remove the topic from the [Missing/Incomplete Article List](missing-and-outdated-list.md) \(if necessary\). * If a file is created or moved, you need to update the Table of Contents \(You can find the file [here](https://github.com/RocketChat/docs/blob/master/_data/toc.yml)\). * Follow this naming convention for Pull Requests: - * When adding new documentation, add `New Documentation:` before the title. E.g. `New Documentation: Authentication Guide`. - * When fixing documentation, add `Fix Documentation:` before the title. E.g. `Fix Documentation: Authentication Guide`. - * When updating documentation, add `Update Documentation:` before the title. E.g. `Update Documentation: Authentication Guide`. + * When adding new documentation, add `New Documentation:` before the title. E.g. `New Documentation: Authentication Guide`. + * When fixing documentation, add `Fix Documentation:` before the title. E.g. `Fix Documentation: Authentication Guide`. + * When updating documentation, add `Update Documentation:` before the title. E.g. `Update Documentation: Authentication Guide`. * If your Pull Request closes an issue you need to write `Closes #ISSUE_NUMBER` where the `ISSUE_NUMBER` is the number in the end of the link url that will link your pull request to the issue, when merged will close that issue. * For each pull request made, we run tests to check if there are any broken links. You can find how to run these tests locally [here](https://docs.rocket.chat/developer-guides/testing/#testing) * We also use a linter tool to check if the style of the markdown matches our [styleguide](markdown-styleguide.md). Here is a link to the [Markdown Linter Tool](https://github.com/markdownlint/markdownlint). @@ -43,8 +43,8 @@ When making small changes like typos and such, there is no problem to edit the f * install ruby \(version 2.5 or higher recommended, if using any version prior to 2.5 you will need to install bundler with `gem install bundler`\). * Install the [Markdown Linter Tool](https://github.com/markdownlint/markdownlint) with `gem install mdl`. * This step is for only macOS users: - * You will need to have either `xcode` or the `xcode command line tools` installed. To install the command tools use `xcode-select --install`. Don't forget to accept the `sudo xcodebuild -license` command. - * Depending on your setup you might need to install [nokogiri](http://www.nokogiri.org/tutorials/installing_nokogiri.html) and its dependencies manually. + * You will need to have either `xcode` or the `xcode command line tools` installed. To install the command tools use `xcode-select --install`. Don't forget to accept the `sudo xcodebuild -license` command. + * Depending on your setup you might need to install [nokogiri](http://www.nokogiri.org/tutorials/installing_nokogiri.html) and its dependencies manually. * Fork the appropriate repository to your account. * This is usually [here](https://github.com/RocketChat/docs). * Clone your fork. diff --git a/contributing/documentation/documentation-map.md b/contributing/documentation/documentation-map.md index f57a925d03..c31efbefcb 100644 --- a/contributing/documentation/documentation-map.md +++ b/contributing/documentation/documentation-map.md @@ -8,511 +8,506 @@ Red Colored Text means that this article is missing from the documentation and n Orange Colored Text means that this article is in the documentation but is incomplete or outdated. - - - span.missing { - color: red; - } - - span.missing a { - color: red; - } - - span.incomplete { - color: orange; - } - - span.incomplete a { - color: orange; - } - + span.missing { + color: red; + } + span.missing a { + color: red; + } + + span.incomplete { + color: orange; + } + + span.incomplete a { + color: orange; + } * Contributing - * Developing - * Google Summer of Code - * Promoting - * Reporting Issues - * Security: - * Responsible Disclosure Policy - * Translating + * Developing + * Google Summer of Code + * Promoting + * Reporting Issues + * Security: + * Responsible Disclosure Policy + * Translating * Getting Support * Installation: - * Rocket.Chat Cloud - * PaaS Deployments: - * Aliyun - * AWS - * Cloudron.io - * Digital Ocean - * DPlatform - * Galaxy - * Google Computer Engine - * Heroku - * IBM Bluemix - * IndieHosters - * Koozali - * Layershift - * OpenShift - * Oracle - * ReadySpace - * Sandstorm.io - * Scalingo - * Sloppy.io - * Docker containers: - * Generic Linux - * systemd - * High Availability Install - * Available Images - * Docker Compose - * Manual Installation: - * CentOS - * Debian - * MacOSX - * Multiple Instances to Improve Performance - * Migrating Meteor Mongo - * OpenSUSE - * [RedHat](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) - * Ubuntu: - * Snaps: - * AutoSSl - * Mongo Options - * Configuring SSL Reverse Proxy - * PM2, Systemd, Upstart - * Running in a sub folder - * Automation tools: - * Ansible - * Openshift - * Vagrant - * Mobile and Desktop Apps - * [Updating](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) - * From 0.x.x to 0.40.0 - * Minimum Requirements - * Community Supported Install: - * FreeBSD - * Universal - * Windows 10 Pro - * Windows Server: + * Rocket.Chat Cloud + * PaaS Deployments: + * Aliyun + * AWS + * Cloudron.io + * Digital Ocean + * DPlatform + * Galaxy + * Google Computer Engine + * Heroku + * IBM Bluemix + * IndieHosters + * Koozali + * Layershift + * OpenShift + * Oracle + * ReadySpace + * Sandstorm.io + * Scalingo + * Sloppy.io + * Docker containers: + * Generic Linux + * systemd + * High Availability Install + * Available Images + * Docker Compose + * Manual Installation: + * CentOS + * Debian + * MacOSX + * Multiple Instances to Improve Performance + * Migrating Meteor Mongo + * OpenSUSE + * [RedHat](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) + * Ubuntu: + * Snaps: + * AutoSSl + * Mongo Options + * Configuring SSL Reverse Proxy + * PM2, Systemd, Upstart + * Running in a sub folder + * Automation tools: + * Ansible + * Openshift + * Vagrant + * Mobile and Desktop Apps + * [Updating](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/ missing-and-outdated-list/index.html) + * From 0.x.x to 0.40.0 + * Minimum Requirements + * Community Supported Install: + * FreeBSD + * Universal + * Windows 10 Pro + * Windows Server: * User guides: - * Connecting to a Server - * Registration - * Login - * Channels - * Messaging - * Channel Actions - * Managing your Account - * Voice and Video Calls + * Connecting to a Server + * Registration + * Login + * Channels + * Messaging + * Channel Actions + * Managing your Account + * Voice and Video Calls * Administrator guides: - * Account Settings - * [Analytics](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) - * [Auto Translation](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) - * Authentication: - * CAS - * Ldap - * [Oauth](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) - * SAML - * [WordPress](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) - * [Custom Oauth](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) - * [Using Rocket.Chat as an Oauth provider](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) - * [oauth2 o365](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) - * [Customizing the UI](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html): - * [Layout](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) - * [Assets](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) - * Custom Emoji - * Custom Fields - * Custom Sounds - * Database-Migration - * Email: - * Setup - * Editing Emails Content - * Mailer - * Direct Reply - * File Upload: - * Amazon S3 - * Google Cloud Storage - * Minio - * [GridFS](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) - * [Local File System](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) - * [General Settings](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) - * [General Section](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) - * [Message Section](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) - * Hubot - * Import: - * CSV - * HipChat: - * [Cloud](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) - * Enterprise - * Slack: - * SlackBridge - * Integrations: - * Zapier: - * Using Zaps - * Azure Alerts - * BitBucket - * Giphy - * GitHub - * GitLab - * Google-Calendar - * Guggy - * Jenkins - * Jira - * NewRelic - * nixstats - * Osticket - * PagerDuty - * Prometheus - * ReviewBoard - * RunDeck - * Sentry - * Telegram - * Travis CI - * Trello - * uptimerobot - * Jitsi Video Bridge - * Livechat: - * Livechat Queues - * Notifications: - * Push Notifications - * Permissions - * Plug-ins: - * Drupal - * Pidgin - * Create the First Admin - * Restoring an Admin - * Settings Via Env Vars -* Developer guides: - * Quick Start - * Branches and Releases - * Client Compatibility Matrix - * Code Styleguide: - * [Less](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) - * Deeplink - * Deprecation - * Iframe Integration: - * [Authentication](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) - * Commands - * Events - * Embedded Layout - * [Internationalization](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) - * Livechat API - * Mobile Apps - * Supporting SSL - * Realtime-API: - * Method Calls: - * Login - * Logout - * Register User - * Get User Roles - * List Custom Emoji - * Load History - * Get Room Roles - * Get Subscriptions - * Get Rooms - * Get Public Settings - * Get Permissions - * User Presence - * Notify Room Stream - * Create Direct Message - * Send Message - * Delete Message - * Update Message - * Pin Message - * Unpin Message - * Set Reaction - * Create Channels - * Create Private Groups - * Delete Rooms - * Archive Rooms - * Unarchive Rooms - * Joining Channels - * Leaving Rooms - * Hiding Rooms - * Opening Rooms - * Favoriting Rooms - * Save Room Settings - * Subscriptions: - * Stream Notify All - * Stream Notify User - * Stream Notify Room - * Stream Room Messages - * The Message Object - * The Room Object - * Livechat API: - * getInitialData - * registerGuest - * sendMessageLivechat - * sendOfflineMessage - * Rest API: - * Assets: - * setAsset - * unsetAsset + * Account Settings + * [Analytics](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) + * [Auto Translation](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) * Authentication: - * facebook - * forgotPassword - * google - * login - * logout - * me - * twitter - * AutoTranslate: - * getSupportedLanguages - * saveSettings - * translateMessage - * Channels: - * addAll - * addLeader - * addModerator - * addOwner - * anonymousread - * archive - * close - * counters - * create - * delete - * files - * getAllUserMentionsByChannel - * getIntegrations - * history - * info - * invite - * join - * kick - * leave - * list.joined - * list - * members - * moderators - * messages - * online - * open - * removeLeader - * removeModerator - * removeOwner - * rename - * roles - * setAnnouncement - * setCustomFields - * setDefault - * setDescription - * setJoinCode - * setPurpose - * setReadOnly - * SetTopic - * setType - * unarchive - * Chat: - * delete - * followMessage - * getDeletedMessages - * getDiscussions - * getMentionedMessages - * getMessage - * getMessageReadReceipts - * getPinnedMessages - * getSnippetedMessages - * getSnippetedMessageById - * getStarredMessages - * getThreadMessages - * getThreadsList - * pinMessage - * postMessage - * react - * reportMessage - * search - * starMessage - * sendMessage - * syncThreadMessages - * syncThreadsList - * unfollowMessage - * unPinMessage - * unStarMessage - * update - * ignoreUser - * Commands: - * get - * list - * run - * Custom Sounds: - * list - * Custom User Status: - * list - * Emoji Custom: - * create - * delete - * list - * update - * Groups: - * addAll - * addLeader - * addModerator - * addOwner - * archive - * close - * counters - * create - * delete - * files - * getIntegrations - * history - * info - * invite - * kick - * leave - * list - * listAll - * members - * messages - * moderators - * open - * removeLeader - * removeModerator - * removeOwner - * rename - * roles - * setAnnouncement - * setCustomFields - * setDescription - * setPurpose - * setReadOnly - * SetTopic - * setType - * unarchive - * Im: - * close - * counters - * create - * files - * history - * list.everyone - * list - * members - * messages - * messages.others - * open - * setTopic - * Integration: - * create - * get - * history - * list - * remove - * Invites: - * findOrCreateInvite - * listInvites - * removeInvite - * useInviteToken - * validateInviteToken + * CAS + * Ldap + * [Oauth](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) + * SAML + * [WordPress](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) + * [Custom Oauth](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) + * [Using Rocket.Chat as an Oauth provider](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) + * [oauth2 o365](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) + * [Customizing the UI](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html): + * [Layout](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) + * [Assets](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) + * Custom Emoji + * Custom Fields + * Custom Sounds + * Database-Migration + * Email: + * Setup + * Editing Emails Content + * Mailer + * Direct Reply + * File Upload: + * Amazon S3 + * Google Cloud Storage + * Minio + * [GridFS](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) + * [Local File System](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) + * [General Settings](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) + * [General Section](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) + * [Message Section](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) + * Hubot + * Import: + * HipChat: + * CSV + * [Cloud](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) + * Enterprise + * Slack: + * SlackBridge + * Integrations: + * Zapier: + * Using Zaps + * Azure Alerts + * BitBucket + * Giphy + * GitHub + * GitLab + * Google-Calendar + * Guggy + * Jenkins + * Jira + * NewRelic + * nixstats + * Osticket + * PagerDuty + * Prometheus + * ReviewBoard + * RunDeck + * Sentry + * Telegram + * Travis CI + * Trello + * uptimerobot + * Jitsi Video Bridge * Livechat: - * agent - * appearance - * config - * custom-fields - * department - * inquiries - * integrations.settings - * message - * office-hours - * room - * rooms - * sms-incoming - * triggers - * users - * video-call - * Miscellaneous: - * directory - * info - * shield.svg - * spotlight - * statistics - * statistics.list - * OAuthApps: - * get - * list - * Permissions: - * list-all - * update - * Roles: - * addUserToRole - * create - * getUsersInRole - * list - * sync - * Push: - * push.token - * deletePushToken - * Rooms: - * adminRooms - * cleanHistory - * createDiscussion - * favorite - * get - * getDiscussions - * info - * leave - * saveNotification - * upload - * Settings: - * get - * update - * oauth - * Subscriptions: - * get - * getOne - * read - * unread - * Users: - * presence - * create - * createToken - * deactivateIdle - * delete - * deleteOwnAccount - * forgotPassword - * generatePersonalAccessToken - * getAvatar - * getPersonalAccessTokens - * getPresence - * get-preferences - * getStatus - * getUsernameSuggestion - * info - * list - * regeneratePersonalAccessToken - * register - * removeOtherTokens - * removePersonalAccessToken - * requestDataDownload - * resetAvatar - * setAvatar - * set-preferences - * setActiveStatus - * setStatus - * update - * updateOwnBasicInfo - * Video Conference: - * jitsi-update-timeout - * Webdav: - * getMyAccounts - * Offset and Count and Sort Info - * Rate Limiter - * Query and Fields Info - * Personal Access Tokens - * [Schema Definition](missing-and-outdated-list.md) + * Livechat Queues + * Notifications: + * Push Notifications + * Permissions + * Plug-ins: + * Drupal + * Pidgin + * Create the First Admin + * Restoring an Admin + * Settings Via Env Vars +* Developer guides: + * Quick Start + * Branches and Releases + * Client Compatibility Matrix + * Code Styleguide: + * [Less](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) + * Deeplink + * Deprecation + * Iframe Integration: + * [Authentication](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) + * Commands + * Events + * Embedded Layout + * [Internationalization](https://github.com/RocketChat/docs/tree/2aa90e0523ba4de4b8aa76d85bc6694671de8a03/contributing/documentation/missing-and-outdated-list/index.html) + * Livechat API + * Mobile Apps + * Supporting SSL + * Realtime-API: + * Method Calls: + * Login + * Logout + * Register User + * Get User Roles + * List Custom Emoji + * Load History + * Get Room Roles + * Get Subscriptions + * Get Rooms + * Get Public Settings + * Get Permissions + * User Presence + * Notify Room Stream + * Create Direct Message + * Send Message + * Delete Message + * Update Message + * Pin Message + * Unpin Message + * Set Reaction + * Create Channels + * Create Private Groups + * Delete Rooms + * Archive Rooms + * Unarchive Rooms + * Joining Channels + * Leaving Rooms + * Hiding Rooms + * Opening Rooms + * Favoriting Rooms + * Save Room Settings + * Subscriptions: + * Stream Notify All + * Stream Notify User + * Stream Notify Room + * Stream Room Messages + * The Message Object + * The Room Object + * Livechat API: + * getInitialData + * registerGuest + * sendMessageLivechat + * sendOfflineMessage + * Rest API: + * Assets: + * setAsset + * unsetAsset + * Authentication: + * facebook + * forgotPassword + * google + * login + * logout + * me + * twitter + * AutoTranslate: + * getSupportedLanguages + * saveSettings + * translateMessage + * Channels: + * addAll + * addLeader + * addModerator + * addOwner + * anonymousread + * archive + * close + * counters + * create + * delete + * files + * getAllUserMentionsByChannel + * getIntegrations + * history + * info + * invite + * join + * kick + * leave + * list.joined + * list + * members + * moderators + * messages + * online + * open + * removeLeader + * removeModerator + * removeOwner + * rename + * roles + * setAnnouncement + * setCustomFields + * setDefault + * setDescription + * setJoinCode + * setPurpose + * setReadOnly + * SetTopic + * setType + * unarchive + * Chat: + * delete + * followMessage + * getDeletedMessages + * getDiscussions + * getMentionedMessages + * getMessage + * getMessageReadReceipts + * getPinnedMessages + * getSnippetedMessages + * getSnippetedMessageById + * getStarredMessages + * getThreadMessages + * getThreadsList + * pinMessage + * postMessage + * react + * reportMessage + * search + * starMessage + * sendMessage + * syncThreadMessages + * syncThreadsList + * unfollowMessage + * unPinMessage + * unStarMessage + * update + * ignoreUser + * Commands: + * get + * list + * run + * Custom Sounds: + * list + * Custom User Status: + * list + * Emoji Custom: + * create + * delete + * list + * update + * Groups: + * addAll + * addLeader + * addModerator + * addOwner + * archive + * close + * counters + * create + * delete + * files + * getIntegrations + * history + * info + * invite + * kick + * leave + * list + * listAll + * members + * messages + * moderators + * open + * removeLeader + * removeModerator + * removeOwner + * rename + * roles + * setAnnouncement + * setCustomFields + * setDescription + * setPurpose + * setReadOnly + * SetTopic + * setType + * unarchive + * Im: + * close + * counters + * create + * files + * history + * list.everyone + * list + * members + * messages + * messages.others + * open + * setTopic + * Integration: + * create + * get + * history + * list + * remove + * Invites: + * findOrCreateInvite + * listInvites + * removeInvite + * useInviteToken + * validateInviteToken + * Livechat: + * agent + * appearance + * config + * custom-fields + * department + * inquiries + * integrations.settings + * message + * office-hours + * room + * rooms + * sms-incoming + * triggers + * users + * video-call + * Miscellaneous: + * directory + * info + * shield.svg + * spotlight + * statistics + * statistics.list + * OAuthApps: + * get + * list + * Permissions: + * list-all + * update + * Roles: + * addUserToRole + * create + * getUsersInRole + * list + * sync + * Push: + * push.token + * deletePushToken + * Rooms: + * adminRooms + * cleanHistory + * createDiscussion + * favorite + * get + * getDiscussions + * info + * leave + * saveNotification + * upload + * Settings: + * get + * update + * oauth + * Subscriptions: + * get + * getOne + * read + * unread + * Users: + * presence + * create + * createToken + * deactivateIdle + * delete + * deleteOwnAccount + * forgotPassword + * generatePersonalAccessToken + * getAvatar + * getPersonalAccessTokens + * getPresence + * get-preferences + * getStatus + * getUsernameSuggestion + * info + * list + * regeneratePersonalAccessToken + * register + * removeOtherTokens + * removePersonalAccessToken + * requestDataDownload + * resetAvatar + * setAvatar + * set-preferences + * setActiveStatus + * setStatus + * update + * updateOwnBasicInfo + * Video Conference: + * jitsi-update-timeout + * Webdav: + * getMyAccounts + * Offset and Count and Sort Info + * Rate Limiter + * Query and Fields Info + * Personal Access Tokens + * [Schema Definition](missing-and-outdated-list.md) * [Testing](missing-and-outdated-list.md) * Troubleshooting * UI and Theming: - * Colors - * Components - * Themes + * Colors + * Components + * Themes * Bots: - * Bots FAQ - * Bots Architecture - * Creating Bot Users - * Configure Bot Environment - * Running a bBot Bot - * Running a Hubot Bot - * Running a Botkit Bot - * Running a Rasa Bot - * Running a Botpress Bot + * Bots FAQ + * Bots Architecture + * Creating Bot Users + * Configure Bot Environment + * Running a bBot Bot + * Running a Hubot Bot + * Running a Botkit Bot + * Running a Rasa Bot + * Running a Botpress Bot * Community Cookbook: - * Remote Video Monitoring - + * Remote Video Monitoring diff --git a/contributing/google-season-of-docs-2019.md b/contributing/google-season-of-docs-2019.md index b9dba62cce..3d20dec9f1 100644 --- a/contributing/google-season-of-docs-2019.md +++ b/contributing/google-season-of-docs-2019.md @@ -100,4 +100,3 @@ Application for technical writers has opened. Please use this [form](https://for * **Mentors**: @rodrigok, @ggazzo * **Description**: The JS SDK is a library of code written in JS that offers an easier interface to communicate with a Rocket.Chat server providing APIs to be called from a JS code that executes commands on the server, like send a message, or retrieve data, like get the list of rooms, abstracting all the logic necessary to handle the communication with the server side. You will be working with Rocket.Chat backend and frontend leads to improve the documentation of all JS SDK methods, from the initial setup of how to get the library and install it to the list of methods, how to use them and the expected returned data. Current documentation is under the SDK repository README. * **Related Material**: [JS SDK repository](https://github.com/RocketChat/Rocket.Chat.js.SDK), [Mention in BOT's Docs](https://docs.rocket.chat/bots/bots-architecture/#rocketchat-js-sdk), [NPM Package](https://www.npmjs.com/package/@rocket.chat/sdk), [Documentation](https://github.com/RocketChat/Rocket.Chat.js.SDK/blob/master/README.md) - diff --git a/contributing/google-summer-of-code-2017.md b/contributing/google-summer-of-code-2017.md index 3748947636..1b823900d6 100644 --- a/contributing/google-summer-of-code-2017.md +++ b/contributing/google-summer-of-code-2017.md @@ -157,8 +157,8 @@ We continue to be extremely optimistic going into the critical mid-term evaluati * **Mentors:** Mitar \([@mitar](https://github.com/mitar)\) Gabriel Engel \([@gabriel.engel](https://github.com/engelgabriel)\) * **Description:** Modify the Rocket.Chat to work on mesh networks. There are two basic types of mesh networks which would be interesting to cover: - * A network of mostly always online off-the-shelf WiFi equipment which forms a network where all network nodes can connect directly to each other \(no NAT\). Here it would be interesting to port Rocket.Chat so that it could run served as a static resource from these limited devices \(which are often not powerful enough to run MongoDB and node.js, which Rocket.Chat otherwise uses for server-side part\). Rocket.Chat should be bundled into a static resource, served over HTTP to clients, which could then use something like WebRTC to connect to each other and communicate with each other. A very thin server-side program might be needed as well, to help with WebRTC connections for example, or discovery of other nodes to connect to. A distributed database like [Scuttlebot](http://scuttlebot.io/) could be used as well. - * A [delay tolerant mesh network](https://en.wikipedia.org/wiki/Delay-tolerant_networking) where devices do not have regular connectivity between each other, and are often even moving around. Such networks often do not even use TCP/IP. On the other hand, devices often have much more storage space and power, when they are available. The idea is to change Rocket.Chat so that it can operate in such environment as well. + * A network of mostly always online off-the-shelf WiFi equipment which forms a network where all network nodes can connect directly to each other \(no NAT\). Here it would be interesting to port Rocket.Chat so that it could run served as a static resource from these limited devices \(which are often not powerful enough to run MongoDB and node.js, which Rocket.Chat otherwise uses for server-side part\). Rocket.Chat should be bundled into a static resource, served over HTTP to clients, which could then use something like WebRTC to connect to each other and communicate with each other. A very thin server-side program might be needed as well, to help with WebRTC connections for example, or discovery of other nodes to connect to. A distributed database like [Scuttlebot](http://scuttlebot.io/) could be used as well. + * A [delay tolerant mesh network](https://en.wikipedia.org/wiki/Delay-tolerant_networking) where devices do not have regular connectivity between each other, and are often even moving around. Such networks often do not even use TCP/IP. On the other hand, devices often have much more storage space and power, when they are available. The idea is to change Rocket.Chat so that it can operate in such environment as well. * **Desirable Skills:** Javascript, WebRTC, networking, OpenWrt, and programming for embedded devices \(C, Lua, bash\) * **Goal/Deliverable:** An OpenWrt package providing a modified Rocket.Chat to work in a mesh network. @@ -175,4 +175,3 @@ We continue to be extremely optimistic going into the critical mid-term evaluati * **Description:** Modify the Rocket.Chat snap to enable mongodb replica's and multi instance Rocket.Chat * **Desirable Skills:** Familiarity with Linux, and bash scripting. * **Goal/Deliverable:** A snap that can be used in a multi-instance HA setup. - diff --git a/contributing/google-summer-of-code-2018.md b/contributing/google-summer-of-code-2018.md index 6cb020d716..986b79b9d0 100644 --- a/contributing/google-summer-of-code-2018.md +++ b/contributing/google-summer-of-code-2018.md @@ -14,8 +14,7 @@ redirect_from: Applications for the GSoC 2018 season have now closed. -UPDATE September 8, 2018 - +UPDATE September 8, 2018 The final list of successful 2018 GSoC Rocket.Chat projects and students/mentors is now [officially](https://summerofcode.withgoogle.com/organizations/6355544806260736/) available. @@ -32,19 +31,19 @@ Our own final tabulation of the status for GSoC projects is as follows: | PASS | Samar Sunkaria | Support for theming the Rocket.Chat iOS app | Matheus Cardoso, Filipe Alvarenga | | WITHDREW | De Sheng Chuan | Data integrity and consistency | Diego Sampaio, Rodrigo Nascimento, Sing Li | -UPDATE August 20, 2018 - This final term has been a term full of changes. One good student - who had been doing great work up to this third term- has had health issues, been hospitalized, and is unable to complete his project. Upon advice from GSoC admin, he withdrew from the project and may resume outside of GSoC upon his recovery. - The "turn around projects" in the second term continued to show major improvement this term - due mainly to the hard work of the affected students. +UPDATE August 20, 2018 + This final term has been a term full of changes. One good student - who had been doing great work up to this third term- has had health issues, been hospitalized, and is unable to complete his project. Upon advice from GSoC admin, he withdrew from the project and may resume outside of GSoC upon his recovery. + The "turn around projects" in the second term continued to show major improvement this term - due mainly to the hard work of the affected students. Mentors and students are busy this term wrapping up their work, preparing for final GSoC evaluation requirements, plus scheduling presentations of their completed work to the larger Rocket.Chat team. Many of the presentations are recorded and are available [here](https://youtu.be/pnz2LCtCeMM), [here](https://www.youtube.com/watch?v=nlsTyJZbKSM), [here](https://www.youtube.com/watch?v=kuDlwnlX67k) and [here](https://ufile.io/jvmbh). As a final result for 2018, one out of our eight GSoC students has withdrawn, and mentors gave final passes to the other seven GSoC projects. Of the four independently funded projects, three passed and one failed \(due to the student's disappearance\). We congratulate the students and mentors on their achievements and sincerely hope all students now have enough of a taste of open source \(and Rocket.Chat in particular\) to continue on their life-long open source contribution as they embark on their next phase of personal development. We will continue to work through the backlog of GSoC project stories on the blog this term. -UPDATE July 15, 2018 - Mentors and students continued to work towards their objectives during this second evaluation period. Due to internal organizational staff changes and other organization operational factors, three problematic projects were identified during this period. Extensive administrative intervention and turn-around was necessary to "salvage" these projects. +UPDATE July 15, 2018 + Mentors and students continued to work towards their objectives during this second evaluation period. Due to internal organizational staff changes and other organization operational factors, three problematic projects were identified during this period. Extensive administrative intervention and turn-around was necessary to "salvage" these projects. Thankfully, the GSoC students worked with us every step of the way as we reassign mentors and realign mutually agreed project scopes. As a result, the \(new in some cases\) project mentors have decided to pass all enrolled students - both GSoC and independently funded projects for this term. Internally, the projects' blog post series is lagging significantly behind, we are working to catch up as soon as possible. -UPDATE June 15, 2018 +UPDATE June 15, 2018 The first evaluation period has come and gone. Our students have been coding feverishly over the past months and many of them have already demonstrated their work to their mentors and teams. We are proud to report that during this evaluation, our mentors have decided to pass all eight of the GSoC students. Our Rocket.Chat-sponsored projects also reported all passes for the three students. We have started to create blog stories around the projects featuring our students - the first story should be available in the next week or two. Due to some internal project logistical problems, one of the students has agreed, together with his mentors and team to switch topic from the second term onwards - to another one of his accepted final proposals - our list below has been amended to reflect the change. We have, through our working partner, been able to fund an additional \(to the 11 that we already have\) highly capable but non-GSoC selected student to work on a Rocket.Chat-related topic. -UPDATE April 25, 2018, AMENDED June 15, 2018 +UPDATE April 25, 2018, AMENDED June 15, 2018 The list of [official GSoC 2018 accepted students and projects](https://summerofcode.withgoogle.com/organizations/6355544806260736/) is now available. First, we would like to sincerely thank every student who has submitted a proposal and many who had worked on PRs and assisted in our open source community - please continue the excellent work. Of the 93 proposals we received, there were many high quality ones. We have also interacted with many of the students in the prior month. The decision-making was difficult and mentors were competitive this year. Ultimately, EIGHT of the top students/proposals this year are accepted for GSoC 2018 \(thank you, Google!\): | Student | Project | Mentors | @@ -68,13 +67,13 @@ In addition, due to the sheer number of high quality entrants, Rocket.Chat has d All of the eleven students have been contacted by mentors and have started the community bonding period. -UPDATE April 2, 2018 - +UPDATE April 2, 2018 - 2018 is an incredible GSoC year for us, we have received a total of NINETY THREE proposals from students studying at every corner of the globe - Brazil, Turkey, USA, Armenia, India, China, Singapore, Hong Kong and more. Thank you, GSoC students, for the overwhelming interest on our project. Proposal topics covered almost all of the suggestions on our idea list - and even a few original ones. Our TWENTY FIVE Rocket.Chat core, guest, and community mentors are hard-at-work right now going through every one of the proposals, and will be contacting students for a video chat prior to deciding on proposal selection and slot assignments. Please keep in touch with us and continue to contribute to the Rocket.Chat project during this time. -UPDATE March 24, 2018 - +UPDATE March 24, 2018 - Students PLEASE NOTE that your final proposal is due on March 27th. It must be in PDF format and submitted via the official GSoC Dashboard. Your Rocket.Chat Core and Guest Industry mentors are looking forward to receive and review your final proposals. -UPDATE March 12, 2018 - +UPDATE March 12, 2018 - Proposal submission for GSoC 2018 has started! Interested students should visit the [GSoC 2018 site](https://summerofcode.withgoogle.com/) to apply and submit their proposals. See the _Project Ideas_ section below for some interesting ideas. You can email the mentor\(s\) directly for discussion and further information. You can also find them, most of the time, on our [community server](https://open.rocket.chat/) for real-time chat. Many of the mentors are fluent in both Portuguese and English. @@ -206,15 +205,15 @@ Interested students are also encouraged to interact with our contributor communi Some projects that you can submit proposals for include: -**Decentralized Crypto Exchange in Rocket.Chat** +##### Decentralized Crypto Exchange in Rocket.Chat * **Description:** Starting either from scratch or utilizing one of the compatible license open source DEX code bases – create a functional Decentralized Exchange within Rocket.Chat. You will create a DEX that takes advantage of strong cryptographic identity solutions such as Blockstack ID and wallet integration such as Metamask or ARK wallet in your work. -**IPFS storage solution in Rocket.Chat** +##### IPFS storage solution in Rocket.Chat * **Description:** Integrate IPFS into Rocket.Chat as a viable storage provider. Ideally IPFS can be used as a storage provider for uploaded Rocket.Chat contents. In addition, the ability to access IPFS within Rocket.Chat, to supply files that can be shared between users of Rocket.Chat is also essential. Leveraging integration with strong cryptographic identities such as Blockstack ID, the solution should include strong data-at-rest encryption of decentralized contents. Use of decentralized storage abstraction frameworks such as Blockstack Gaia should be considered to simplify this work. Use of IPFS as a decentralized storage for Rocket.Chat’s data should also be considered within the term. -**Cryptocurrency Wallet and/or Portfolio Management in Rocket.Chat** +##### Cryptocurrency Wallet and/or Portfolio Management in Rocket.Chat * **Description:** Enable the integration of wallet\(s\) such as Metamask, MyEtherWallet, ARK or other wallets or crypto portfolio management system within Rocket.Chat. * **Desirable Skills:** Looking for a unique fringe-dropout university student already committed to our inevitable decentralized future powered by Web 3.0 and continued blockchain technology innovations. While maintaining a high score on all your subjects, you should be finding your existing university education ridiculously limiting, and already have experience hacking smart contracts, minting tokens for friends and family, hacking ethereum, and trading cryptokitties. You eat truffle for breakfast and ride the open zepplin to school every day. Recent government \(perhaps your own government\) baseless advances into this area has significantly disturbed you. You already realized that you are way ahead of your time. And you will recognize this GSoC 2018 project to be the absolutely not-to-miss opportunity of your life. @@ -285,11 +284,10 @@ Some projects that you can submit proposals for include: * **Mentors:** Mrinal Dhar \(@mrinal.dhar\) * **Description:** Implement a calendar within Rocket.Chat for scheduling events and reminders, offering standalone functionality as well as integration with other calendars out there \(Google Calendar, for example\). Desirable features: - * Ability to schedule events and set up alerts for them. - * Automatically detect dates and time from messages and allow creating events from them. For example: In the message "Lets meet tomorrow", "tomorrow" should be automatically highlighted and user can then schedule an event by clicking on it. - * In a conversation, allow each user to select preferred time-slots and automatically schedule an event based on everyone's preferences. - * A consolidated events view that lists all scheduled events for a particular day, week or month. - * Integration with Google Calendar - * Ability to search for an event + * Ability to schedule events and set up alerts for them. + * Automatically detect dates and time from messages and allow creating events from them. For example: In the message "Lets meet tomorrow", "tomorrow" should be automatically highlighted and user can then schedule an event by clicking on it. + * In a conversation, allow each user to select preferred time-slots and automatically schedule an event based on everyone's preferences. + * A consolidated events view that lists all scheduled events for a particular day, week or month. + * Integration with Google Calendar + * Ability to search for an event * **Desirable Skills:** Familiarity with JavaScript development required. Previous experience with NLP \(Natural Language Processing\) or AI \(Artificial Intelligence\) would be helpful. - diff --git a/contributing/google-summer-of-code-2020.md b/contributing/google-summer-of-code-2020.md index 5af9282abc..04196216af 100644 --- a/contributing/google-summer-of-code-2020.md +++ b/contributing/google-summer-of-code-2020.md @@ -270,12 +270,12 @@ Interested students are also encouraged to interact with our contributor communi * **Mentors**: [@diego.sampaio](https://open.rocket.chat/direct/diego.sampaio) and [@rodrigo.nascimento](https://open.rocket.chat/direct/rodrigo.nascimento) * **Project repository**: [https://github.com/RocketChat/Rocket.Chat.Houston](https://github.com/RocketChat/Rocket.Chat.Houston) * **Description**: Huston is the CLI tooling we use to release new versions of Rocket.Chat and to generate our change logs from merged pull requests. We want to: - * Rewrite the tooling in TypeScript; - * ~Improve the changelog generation getting more information from the PRs like description, images, etc;~ \(already done\) - * Accept a new format of PR titles \(conventional changelog\); - * Add a validation system for PRs titles via GitHub Actions; - * Add a tooling to preview the generated changelog for the PR - * Add new top level of separation for product type \(like Enterprise and Community\) based on labels + * Rewrite the tooling in TypeScript; + * ~Improve the changelog generation getting more information from the PRs like description, images, etc;~ \(already done\) + * Accept a new format of PR titles \(conventional changelog\); + * Add a validation system for PRs titles via GitHub Actions; + * Add a tooling to preview the generated changelog for the PR + * Add new top level of separation for product type \(like Enterprise and Community\) based on labels #### Add Support for Bixby @@ -323,4 +323,3 @@ Interested students are also encouraged to interact with our contributor communi **April 27th 18:00 UTC** Accepted student proposals announced ... - diff --git a/developer-guides/code-styleguide/less.md b/developer-guides/code-styleguide/less.md index 4ffc2d94c6..9e3a2bce88 100644 --- a/developer-guides/code-styleguide/less.md +++ b/developer-guides/code-styleguide/less.md @@ -11,8 +11,8 @@ * Prefer line comments \(`//`\) to block comments. * Prefer comments on their own line. Avoid end-of-line comments. * Write detailed comments for code that isn't self-documenting: - * Uses of z-index - * Compatibility or browser-specific hacks + * Uses of z-index + * Compatibility or browser-specific hacks ## Formatting @@ -28,7 +28,7 @@ * Try to not use `!important`. * Lowercase, always :\) -**Bad** +### **Bad** ```css blockquote { @@ -65,7 +65,7 @@ blockquote { } ``` -**Good** +### **Good** ```css blockquote { @@ -109,9 +109,9 @@ blockquote { ## Selectors -### Create an empty line before selectors. +### Create an empty line before selectors -**Bad** +#### **Bad** ```css .class { @@ -122,7 +122,7 @@ blockquote { } ``` -**Good** +#### **Good** ```css .class { @@ -134,9 +134,9 @@ blockquote { } ``` -### Use a single space after selectors. +### Use a single space after selectors -**Bad** +#### **Bad** ```css .class{ @@ -144,7 +144,7 @@ blockquote { } ``` -**Good** +#### **Good** ```css .class { @@ -152,9 +152,9 @@ blockquote { } ``` -### Add an empty line before nested selectors. +### Add an empty line before nested selectors -**Bad** +#### **Bad** ```css .class { @@ -165,7 +165,7 @@ blockquote { } ``` -**Good** +#### **Good** ```css .class { @@ -177,9 +177,9 @@ blockquote { } ``` -### Use an empty line before non-nested selectors. +### Use an empty line before non-nested selectors -**Bad** +#### **Bad** ```css .class { @@ -194,7 +194,7 @@ blockquote { } ``` -**Good** +#### **Good** ```css .class { @@ -210,9 +210,9 @@ blockquote { } ``` -### Don’t add whitespaces inside of the brackets within attribute selectors. +### Don’t add whitespaces inside of the brackets within attribute selectors -**Bad** +#### **Bad** ```css .input[ type="text" ] { @@ -220,7 +220,7 @@ blockquote { } ``` -**Good** +#### **Good** ```css .input[type="text"] { @@ -228,9 +228,9 @@ blockquote { } ``` -### Don’t add a whitespace between operators within attribute selectors. +### Don’t add a whitespace between operators within attribute selectors -**Bad** +#### **Bad** ```css .input[type = "text" ] { @@ -238,7 +238,7 @@ blockquote { } ``` -**Good** +#### **Good** ```css .input[type="text"] { @@ -246,9 +246,9 @@ blockquote { } ``` -### Always use a single space between the combinators of selectors. +### Always use a single space between the combinators of selectors -**Bad** +#### **Bad** ```css .class>.button { @@ -256,7 +256,7 @@ blockquote { } ``` -**Good** +#### **Good** ```css .class > .button { @@ -264,9 +264,9 @@ blockquote { } ``` -### Add a newline after the commas of selector lists. +### Add a newline after the commas of selector lists -**Bad** +#### **Bad** ```css .class, .another, .another-class { @@ -274,7 +274,7 @@ blockquote { } ``` -**Good** +#### **Good** ```css .class, @@ -284,9 +284,9 @@ blockquote { } ``` -### Don’t add a whitespace inside of the parentheses within pseudo-class selectors. +### Don’t add a whitespace inside of the parentheses within pseudo-class selectors -**Bad** +#### **Bad** ```css .class:not( .another ) { @@ -294,7 +294,7 @@ blockquote { } ``` -**Good** +#### **Good** ```css .class:not(.another) { @@ -302,9 +302,9 @@ blockquote { } ``` -### Double colon for applicable pseudo-elements. +### Double colon for applicable pseudo-elements -**Bad** +#### **Bad** ```css .class:before { @@ -316,7 +316,7 @@ blockquote { } ``` -**Good** +#### **Good** ```css .class::before { @@ -330,9 +330,9 @@ blockquote { ## Properties -### Don’t add empty line in first/last property or in between properties. +### Don’t add empty line in first/last property or in between properties -**Bad** +#### **Bad** ```css .room-list { @@ -345,7 +345,7 @@ blockquote { } ``` -**Good** +#### **Good** ```css .room-list { @@ -355,15 +355,15 @@ blockquote { } ``` -### Don't add properties in single-line. Use one property per line. +### Don't add properties in single-line. Use one property per line -**Bad** +#### **Bad** ```css .sumbit {color: #ffffff; background-color: #000000;} ``` -**Good** +#### **Good** ```css .sumbit { @@ -372,15 +372,15 @@ blockquote { } ``` -### No empty blocks. +### No empty blocks -**Bad** +#### **Bad** ```css .button {} ``` -**Good** +#### **Good** ```css .button { @@ -388,9 +388,9 @@ blockquote { } ``` -### Longhand properties must be combined into one shorthand property. +### Longhand properties must be combined into one shorthand property -**Bad** +#### **Bad** ```css .class { @@ -400,7 +400,7 @@ blockquote { } ``` -**Good** +#### **Good** ```css .class { @@ -408,9 +408,9 @@ blockquote { } ``` -### Don’t use shorthand properties that override related longhand properties. +### Don’t use shorthand properties that override related longhand properties -**Example** +#### **Example** ```css .class { @@ -419,9 +419,9 @@ blockquote { } ``` -### Always add a trailing semicolon in the end of a declaration. +### Always add a trailing semicolon in the end of a declaration -**Bad** +#### **Bad** ```css .another-class { @@ -430,7 +430,7 @@ blockquote { } ``` -**Good** +#### **Good** ```css .another-class { @@ -439,9 +439,9 @@ blockquote { } ``` -### Add a newline after the colon of declarations. +### Add a newline after the colon of declarations -**Bad** +#### **Bad** ```css .another-class { @@ -449,7 +449,7 @@ blockquote { } ``` -**Good** +#### **Good** ```css .another-class { @@ -459,9 +459,9 @@ blockquote { } ``` -### Don’t duplicate properties within declaration blocks. +### Don’t duplicate properties within declaration blocks -**Bad** +#### **Bad** ```css .another-class { @@ -471,7 +471,7 @@ blockquote { } ``` -**Good** +#### **Good** ```css .another-class { @@ -480,9 +480,9 @@ blockquote { } ``` -### Don’t duplicate selectors along the file. +### Don’t duplicate selectors along the file -**Bad** +#### **Bad** ```css .some-class { @@ -497,7 +497,7 @@ blockquote { } ``` -**Good** +#### **Good** ```css .some-class { @@ -507,9 +507,9 @@ blockquote { } ``` -### Add a whitespace before bang \(!\) declaration. +### Add a whitespace before bang \(!\) declaration -**Bad** +#### **Bad** ```css .class { @@ -517,7 +517,7 @@ blockquote { } ``` -**Good** +#### **Good** ```css .class { @@ -525,9 +525,9 @@ blockquote { } ``` -### Use spaces around calc operators. +### Use spaces around calc operators -**Bad** +#### **Bad** ```css .class { @@ -535,7 +535,7 @@ blockquote { } ``` -**Good** +#### **Good** ```css .class { @@ -543,9 +543,9 @@ blockquote { } ``` -### Remove units for zero lengths. +### Remove units for zero lengths -**Bad** +#### **Bad** ```css .button { @@ -553,7 +553,7 @@ blockquote { } ``` -**Good** +#### **Good** ```css .button { @@ -561,9 +561,9 @@ blockquote { } ``` -### Use a leading zero for fractional numbers css than 1. +### Use a leading zero for fractional numbers css than 1 -**Bad** +#### **Bad** ```css .message-form { @@ -571,7 +571,7 @@ blockquote { } ``` -**Good** +#### **Good** ```css .message-form { @@ -579,9 +579,9 @@ blockquote { } ``` -### Don’t add trailing zeros in numbers. +### Don’t add trailing zeros in numbers -**Bad** +#### **Bad** ```css .flex-tab { @@ -589,7 +589,7 @@ blockquote { } ``` -**Good** +#### **Good** ```css .flex-tab { @@ -597,9 +597,9 @@ blockquote { } ``` -### Don’t add newlines in strings. +### Don’t add newlines in strings -**Bad** +#### **Bad** ```css .nav-link::before { @@ -608,7 +608,7 @@ blockquote { } ``` -**Good** +#### **Good** ```css .nav-link::before { @@ -618,11 +618,11 @@ blockquote { ## Colors -### Lowercase, always. +### Lowercase, always -### Long notation. +### Long notation -**Bad** +#### **Bad** ```css .another-class { @@ -630,11 +630,10 @@ blockquote { } ``` -**Good** +#### **Good** ```css .another-class { background-color: #ffffff; } ``` - diff --git a/developer-guides/rest-api/authentication/login.md b/developer-guides/rest-api/authentication/login.md index e7401acbad..7be6f410dc 100644 --- a/developer-guides/rest-api/authentication/login.md +++ b/developer-guides/rest-api/authentication/login.md @@ -13,11 +13,11 @@ Login with your username and password. | `user` | `foo@bar.com` OR `myusername` | Required | Your username or email | | `password` | `my$up3erP@ssw0rd` | Required | Your password | -**Notes** +### Notes -* **You will need to provide the `authToken` and `userId` for any of the authenticated methods.** -* **If your user has two-factor\(2FA\) authentication enabled, you must send a request like** [**this**](login.md#example-call---when-two-factor2fa-authentication-is-enabled)**.** -* **If LDAP authentication is enabled, you must maintain the login in the same way as you normally do. Similarly if 2FA is enabled for an LDAP user. Everything stays the same.** +* **You will need to provide the `authToken` and `userId` for any of the authenticated methods.** +* **If your user has two-factor\(2FA\) authentication enabled, you must send a request like** [**this**](login.md#example-call---when-two-factor2fa-authentication-is-enabled)**.** +* **If LDAP authentication is enabled, you must maintain the login in the same way as you normally do. Similarly if 2FA is enabled for an LDAP user. Everything stays the same.** ## Example Call - As Form Data @@ -100,4 +100,3 @@ curl -H "Content-type:application/json" \ | 1.0.0 | Added `avatarUrl` property to response | | 0.64.0 | Added `me` property to response | | 0.60.0 | Added | - diff --git a/developer-guides/rest-api/query-and-fields-info.md b/developer-guides/rest-api/query-and-fields-info.md index 8ea983b5da..362a6c971f 100644 --- a/developer-guides/rest-api/query-and-fields-info.md +++ b/developer-guides/rest-api/query-and-fields-info.md @@ -13,7 +13,8 @@ To query the users which has a name that has `g` in it somewhere. `https://localhost:3000/api/v1/users.list?query={ "name": { "$regex": "g" } }` -**Note** +### **Note** + The allowed structure is [EJSON](https://docs.meteor.com/api/ejson.html), which is similar to JSON, except in the `Date` and `binary` fields. For query objects that use `Date` fields, you should use the structure as the example below: `query={"_updatedAt": {"$gt": { "$date": 1542814057 } }}` or `query={"_updatedAt":{"$gt":{"$date":"2018-11-21T15:27:28.202Z"}}}` ## Fields Example diff --git a/developer-guides/rest-api/settings/update.md b/developer-guides/rest-api/settings/update.md index 2dd1412a69..293d4e25e4 100644 --- a/developer-guides/rest-api/settings/update.md +++ b/developer-guides/rest-api/settings/update.md @@ -11,7 +11,7 @@ this.add('Accounts_AllowAnonymousRead', false, { }); ``` -means that the setting labeled "Allow anonymous read" in the section "Accounts" has `_id` equal to `'Accounts_AllowAnonymousRead'`. The second argument is the default value \(`false`\). The third argument specifies the variable's type and whether it is public, hidden, and so on. +means that the setting labeled "Allow anonymous read" in the section "Accounts" has `_id` equal to `'Accounts_AllowAnonymousRead'`. The second argument is the default value \(`false`\). The third argument specifies the variable's type and whether it is public, hidden, and so on. To set a color, you can send ```text diff --git a/developer-guides/rest-api/users/createtoken.md b/developer-guides/rest-api/users/createtoken.md index bc7ce9e313..5f64485bee 100644 --- a/developer-guides/rest-api/users/createtoken.md +++ b/developer-guides/rest-api/users/createtoken.md @@ -1,6 +1,6 @@ # Create Token -**IMPORTANT** +**IMPORTANT** To be able to use this endpoint you must set the ENV VAR \(CREATE\_TOKENS\_FOR\_USERS=true\). Create a user authentication token. This is the same type of session token a user would get via login and will expire the same way. Requires `user-generate-access-token` permission. diff --git a/developer-guides/ui-and-theming/components.md b/developer-guides/ui-and-theming/components.md index aea58613f1..6b961f2c8c 100644 --- a/developer-guides/ui-and-theming/components.md +++ b/developer-guides/ui-and-theming/components.md @@ -11,14 +11,14 @@ _Describe usage for template development contributions_ _Provide example usage and html structure / class names of nested elements_ * Content - * Admin Link - * Input Line - * Button + * Admin Link + * Input Line + * Button * Account Box - * Status - * Account Link + * Status + * Account Link * Rooms List - * Header - * Item - * Item List + * Header + * Item + * Item List diff --git a/developer-guides/ui-and-theming/themes.md b/developer-guides/ui-and-theming/themes.md index a8ed1d55d9..9ff1eb86cc 100644 --- a/developer-guides/ui-and-theming/themes.md +++ b/developer-guides/ui-and-theming/themes.md @@ -61,13 +61,13 @@ A suggested approach for including custom templates and helpers is to use the `' Here's an example replacing the unauthorized page template: - **In `package.js`** + **In `package.js`** ```javascript api.addFiles(['views/notAuthorized.html', 'client.coffee'], 'client'); ``` - **In `views/notAuthorized.html`** + **In `views/notAuthorized.html`** ```markup ``` - **In `client.coffee`** + **In `client.coffee`** ```coffeescript Template.myNotAuthorized.replaces 'notAuthorized' diff --git a/installation/automation-tools/ansible.md b/installation/automation-tools/ansible.md index c5f7970ae7..396a6edfba 100644 --- a/installation/automation-tools/ansible.md +++ b/installation/automation-tools/ansible.md @@ -49,10 +49,10 @@ So, now you've got Ansible installed, you can get ready to deploy Rocket.Chat! * The system you're deploying to must have Python installed \(pretty much comes with most operating systems nowadays, easy to install if not\). * The system you're deploying to must run one of the following operating systems: - * EL 7 \(RHEL/CentOS\) - * Debian 8 \(Jessie\) LTS - * Ubuntu 16.04 LTS - * Ubuntu 19.04 + * EL 7 \(RHEL/CentOS\) + * Debian 8 \(Jessie\) LTS + * Ubuntu 16.04 LTS + * Ubuntu 19.04 Future releases of the [official Rocket.Chat Ansible role](https://galaxy.ansible.com/RocketChat/Server/#readme) will include other Linux distributions/releases and other operating systems. If you'd like to see your OS of choice supported, feel free to [raise an issue](https://github.com/RocketChat/Rocket.Chat.Ansible/issues) to ask if it can be added. diff --git a/installation/community-supported-installation/opensuse.md b/installation/community-supported-installation/opensuse.md index ca71141d69..91c0f3a6f5 100644 --- a/installation/community-supported-installation/opensuse.md +++ b/installation/community-supported-installation/opensuse.md @@ -35,14 +35,14 @@ Things you'll need to do afterwards on your own, **especially if you want a prod * Configure email on the server \(so Rocket can request account validation\) * Secure the server \(e.g. get rid of the default user on a VM, etc.\) * Monitor the server so you can respond if it goes down - * Rocket.Chat availability - * MongoDB availability - * nginx availability + * Rocket.Chat availability + * MongoDB availability + * nginx availability * Configure MongoDB for production use - * Use an XFS volume - * Use persistent \(e.g. non-local\) storage if you're using a VM - * Configure replica sets - * Consider setting /sys/kernel/mm/transparent\_hugepage/enabled to "never" as recommended by Mongo at startup + * Use an XFS volume + * Use persistent \(e.g. non-local\) storage if you're using a VM + * Configure replica sets + * Consider setting /sys/kernel/mm/transparent\_hugepage/enabled to "never" as recommended by Mongo at startup * Set up periodic updates for the system ## Acquire a VM with OpenSUSE Leap 42.2 diff --git a/installation/community-supported-installation/windows-server.md b/installation/community-supported-installation/windows-server.md index 38c7250e6a..b4acfa96b8 100644 --- a/installation/community-supported-installation/windows-server.md +++ b/installation/community-supported-installation/windows-server.md @@ -85,11 +85,11 @@ Rocket.Chat is built on top of Node.js v8.9.3. So we need to install this first. 1. Open the _Windows SDK 7.1 Command Prompt_ by pressing Start, typing its name, and clicking on it in the search results \(Note: It needs to be the SDK Command Prompt\) 2. Now enter the following, replacing: - * \[Installation Path\] with the location you placed the Rocket.Chat files - * \[Port to Use\] with the port for the Rocket.Chat server to use, such as `3000` - * \[Rocket.Chat URL\] with the URL you will use for Rocket.Chat, such as `rocketchat.example.com` - * \[Address to MongoDB\] with the IP Address of your MongoDB. \(NOTE: If you didn't install Mongo on another computer, use `localhost`\) - * \[MongoDB Database\] with the name of the database you would like to use, such as `rocketchat` + * \[Installation Path\] with the location you placed the Rocket.Chat files + * \[Port to Use\] with the port for the Rocket.Chat server to use, such as `3000` + * \[Rocket.Chat URL\] with the URL you will use for Rocket.Chat, such as `rocketchat.example.com` + * \[Address to MongoDB\] with the IP Address of your MongoDB. \(NOTE: If you didn't install Mongo on another computer, use `localhost`\) + * \[MongoDB Database\] with the name of the database you would like to use, such as `rocketchat` ```text > SetEnv /x86 diff --git a/installation/manual-installation/mongo-versions.md b/installation/manual-installation/mongo-versions.md index 9e32ef77ac..fb57d36cfa 100644 --- a/installation/manual-installation/mongo-versions.md +++ b/installation/manual-installation/mongo-versions.md @@ -2,8 +2,8 @@ Rocket.Chat currently requires MongoDB from version 3.6 and higher. [Support of MongoDB 3.2 will be removed from Rocket Chat 2.0.0 and MongoDB 3.4 will be removed from Rocket Chat 4.x](https://github.com/RocketChat/Rocket.Chat/pull/15199). We recommend using version 3.6.9. -**Note** - Without mongodb version we can't ensure you are running a compatible version. If you are running your mongodb with auth enabled and an **user different from admin** you may need to grant permissions for this user to check cluster data. +**Note** + Without mongodb version we can't ensure you are running a compatible version. If you are running your mongodb with auth enabled and an **user different from admin** you may need to grant permissions for this user to check cluster data. You can do it via mongo shell running the following command replacing the string _YOUR\_USER_ by the correct user\'s name: ```text diff --git a/user-guides/managing-your-account.md b/user-guides/managing-your-account.md index 5af048640f..d25f485c04 100644 --- a/user-guides/managing-your-account.md +++ b/user-guides/managing-your-account.md @@ -24,16 +24,16 @@ Enable or disable all desktop notifications, test desktop notifications, and con * The global notification duration in seconds * Enter key behaviour: - * Normal mode \(send with Enter\) - * Alternative mode \(send with Enter + Ctrl/Alt/Shift/CMD\) - * Desktop mode \(only sends with Enter on desktop\) + * Normal mode \(send with Enter\) + * Alternative mode \(send with Enter + Ctrl/Alt/Shift/CMD\) + * Desktop mode \(only sends with Enter on desktop\) * View mode - * Normal: The default spacing between messages - * Cozy: More space between messages \(less on the screen\) - * Compact: Less space between messages \(more on the screen\) + * Normal: The default spacing between messages + * Cozy: More space between messages \(less on the screen\) + * Compact: Less space between messages \(more on the screen\) * Offline Email Notifications - * Disabled - * Every Mention/Direct Message + * Disabled + * Every Mention/Direct Message As well as enable or disable the following preferences: diff --git a/user-guides/messaging.md b/user-guides/messaging.md index 48b45f7e14..3be1fd5bd2 100644 --- a/user-guides/messaging.md +++ b/user-guides/messaging.md @@ -103,7 +103,6 @@ Use the following symbols to format text as desired: * Bold: `*Lorem ipsum dolor*` * Italic: `_Lorem ipsum dolor_` * Strike: `~Lorem ipsum dolor~` -* Inline code: ```Lorem ipsum dolor``` +* Inline code: ```Lorem ipsum dolor``` * Image: `![Alt text](https://rocket.chat/favicon.ico)` * Link: `[Lorem ipsum dolor](https://www.rocket.chat/)` or `` -