Fix broken links/markdown on the docs (RocketChat#533)

CODE_OF_CONDUCT.md

@@ -8,19 +8,19 @@ In the interest of fostering an open and welcoming environment, we as contributo
 
 Examples of behavior that contributes to creating a positive environment include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Our Responsibilities
 
@@ -43,4 +43,5 @@ Project maintainers who do not follow or enforce the Code of Conduct in good fai
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
 
 [homepage]: http://contributor-covenant.org
+
 [version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -24,7 +24,7 @@ All missing/incomplete articles are links to a list with the description of each
 You can find a list of issues [here](https://github.com/RocketChat/Rocket.Chat.Docs/issues).
 When you find something you would like to work on just comment on it and we will add an __In Progress__ label.
 
----
+- - -
 
 ## Creating a new Pull Request
 
@@ -77,7 +77,7 @@ If you add a page called `Testing Rocket.Chat Apps`, it will be converted to `te
 
 All words will be lowercased, spaces will be replaced with a `-` and any special character will be removed (like the `.` on `Rocket.Chat`)
 
----
+- - -
 
 ## Reporting Issues and Missing Articles
 

README.md

@@ -4,13 +4,14 @@
 ---
 
 # Rocket.Chat Docs
+
 ## What would you like to do?
 
-* [Learn how to use Rocket.Chat](user-guides/)
-* [Get support](getting-support/)
-* [Install Rocket.Chat](installation/)
-* [Administer your installation](administrator-guides/)
-* [Contribute to the project](contributing/)
+- [Learn how to use Rocket.Chat](user-guides/)
+- [Get support](getting-support/)
+- [Install Rocket.Chat](installation/)
+- [Administer your installation](administrator-guides/)
+- [Contribute to the project](contributing/)
 
 ![image](mockup.png)
 

Rakefile

@@ -48,6 +48,6 @@ require 'html-proofer'
 
 task :test do
   sh "bundle exec jekyll build"
-  options = { :assume_extension => true, :allow_hash_href => true }
+  options = { :assume_extension => true, :allow_hash_href => true, :empty_alt_ignore => true, :disable_external => true }
   HTMLProofer.check_directory("./_site", options).run
 end

_layouts/default.html

@@ -81,7 +81,7 @@
         {% include toc.html %}
       </div>
       <div id="content" class="content">
-        <div class="wrapper">
+        <div class="wrapper" {%if page.ignoreLinks%}data-proofer-ignore{% endif %}>
           {{ content }}
           <div class="edit-github"><a href="https://github.com/RocketChat/docs/blob/master{{page.url}}README.md">Edit this page on GitHub</a></div>
         </div>
@@ -107,7 +107,7 @@
       <li><a href="https://rocket.chat/blog/">Blog</a></li>
     </ul>
     <ul>
-      <li><a href="https://shop.spreadshirt.com/rocketchat" target="_blank">Store</a></li>
+      <li><a href="https://shop.spreadshirt.com/rocketchat" target="_blank" data-proofer-ignore>Store</a></li>
       <li><a href="https://www.stickermule.com/user/1070688638/stickers" target="_blank">Stickers</a></li>
     </ul>
   </div>

administrator-guides/account-settings/README.md

@@ -4,52 +4,52 @@ In this section you can modify various settings about the accounts of the users
 
 In this guide we will go over all settings in the _Accounts_ Section.
 
-- __Allow anonymous read__: Setting this to true will allow people to use the chat without having to create a account or log in. Anonymous users will be only allowed to read messages on public channels.
-- __Allow anonymous write__: This will allow Anonymous users to post messages on public channels.
-- __Allow users to delete own account__: Setting this to true allows users to delete they own account. When a user is deleted all their messages are deleted too.
-- __Allow User Profile Change__: Setting this to false will block users from changing information on their profile.
-- __Allow User Avatar Change__: Setting this to false will block users from changing their avatar.
-- __Allow User Username Change__: Setting this to false will block users from changing their username.
-- __Allow User Email Change__: Setting this to false will block users from changing their email
-- __Allow User Password Change__: Setting this to false will block users from changing their password.
+- **Allow anonymous read**: Setting this to true will allow people to use the chat without having to create a account or log in. Anonymous users will be only allowed to read messages on public channels.
+- **Allow anonymous write**: This will allow Anonymous users to post messages on public channels.
+- **Allow users to delete own account**: Setting this to true allows users to delete they own account. When a user is deleted all their messages are deleted too.
+- **Allow User Profile Change**: Setting this to false will block users from changing information on their profile.
+- **Allow User Avatar Change**: Setting this to false will block users from changing their avatar.
+- **Allow User Username Change**: Setting this to false will block users from changing their username.
+- **Allow User Email Change**: Setting this to false will block users from changing their email
+- **Allow User Password Change**: Setting this to false will block users from changing their password.
 
 <!-- - __Custom Fields to Show in User Info__: link to dedicated custom field document -->
 
-- __Login Expiration in Days__: After this number of days of inactivity the user will be logged out.
-- __Show form-based Login__: Setting this to false will remove the log in form from the login screen. This setting is useful when you are using a third party login system.
-- __Placeholder for email or username login field__: This will change the placeholder for the _email or username_ field on the login screen.
-- __Placeholder for password login field__: This will change the placeholder for the _password_ field on the login screen.
-- __Forget user session on window close__: This will log out users when they close the window containing Rocket.Chat
+- **Login Expiration in Days**: After this number of days of inactivity the user will be logged out.
+- **Show form-based Login**: Setting this to false will remove the log in form from the login screen. This setting is useful when you are using a third party login system.
+- **Placeholder for email or username login field**: This will change the placeholder for the _email or username_ field on the login screen.
+- **Placeholder for password login field**: This will change the placeholder for the _password_ field on the login screen.
+- **Forget user session on window close**: This will log out users when they close the window containing Rocket.Chat
 
 ## Avatar
 
-- __Resize Avatar__: Set this to true to resize users avatars to a predefined size. You need ImageMagick or GraphicsMagick installed on your server for this feature to work.
-- __Avatar Size__: The desired size after the avatar resizing. The unit is pixels (px).
-- __Set Default Avatar__: If this setting is set to true, Rocket.Chat will try to find a default avatar based on OAuth Account or Gravatar.
+- **Resize Avatar**: Set this to true to resize users avatars to a predefined size. You need ImageMagick or GraphicsMagick installed on your server for this feature to work.
+- **Avatar Size**: The desired size after the avatar resizing. The unit is pixels (px).
+- **Set Default Avatar**: If this setting is set to true, Rocket.Chat will try to find a default avatar based on OAuth Account or Gravatar.
 
 ## Iframe
 
-These settings are related to the Iframe Integration, please se the [Iframe integration page] (/developers-guides/iframe-integration) for more details.
+These settings are related to the Iframe Integration, please se the [Iframe integration page](../../developer-guides/iframe-integration) for more details.
 
 ## Registration
 
-- __Default username prefix suggestion__: This is the prefix that will be suggested when a user is creating a username.
-- __Require Name For Signup__: If this is set to true, the name of the user will be required to create a account.
-- __Require Password Confirmation__: If this is set to true, the user will have to input his password twice when registering.
-- __Email Verification__: If this is set to true, users will have to confirm their email via a confirmation email sent to their email. (For this setting work, the SMTP settings must be already set up. See [Email Configuration](../../../administrator-guides/email/setup))
-- __Manually Approve New Users__: If this is set to true, new users will have to wait for a user with the `view-user-administration` permission to approve their account before using Rocket.Chat.
-- __Allowed Domains List__:  This will block emails with different domains than the ones on this list.
-- __Blocked Domains List__:  This will block emails with domains that are on on this list.
-- __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 wont be able to register with invalid domains.
-- __Registration Form__: This will change how the registration form is presented. Currently there are 3 options:
+- **Default username prefix suggestion**: This is the prefix that will be suggested when a user is creating a username.
+- **Require Name For Signup**: If this is set to true, the name of the user will be required to create a account.
+- **Require Password Confirmation**: If this is set to true, the user will have to input his password twice when registering.
+- **Email Verification**: If this is set to true, users will have to confirm their email via a confirmation email sent to their email. (For this setting work, the SMTP settings must be already set up. See [Email Configuration](../email/setup))
+- **Manually Approve New Users**: If this is set to true, new users will have to wait for a user with the `view-user-administration` permission to approve their account before using Rocket.Chat.
+- **Allowed Domains List**:  This will block emails with different domains than the ones on this list.
+- **Blocked Domains List**:  This will block emails with domains that are on on this list.
+- **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 wont 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 disable and users wont 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]`.
-- __Registration Form Link Replacement Text__: Text to be shown in place of the registration form when the registration form is disabled.
-- __Registration with Authentication Services__: Set this to true to allow registration with third party authentication services like Google or Twitter.
-- __Default Roles for Authentication Services__: Default roles users will be given when registering through authentication services.
-- __Password Reset__: Set this to true to allow users to reset their password.
+- **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]`.
+- **Registration Form Link Replacement Text**: Text to be shown in place of the registration form when the registration form is disabled.
+- **Registration with Authentication Services**: Set this to true to allow registration with third party authentication services like Google or Twitter.
+- **Default Roles for Authentication Services**: Default roles users will be given when registering through authentication services.
+- **Password Reset**: Set this to true to allow users to reset their password.
 
 <!--- __Custom Fields__ TODO: Create dedicated custom field document, since is a big topic -->

administrator-guides/authentication/saml/README.md

@@ -6,7 +6,7 @@
 
 This is the unique name for your application as a Service Provider (SP) for SAML. Whatever you enter here will produce a metadata XML file you will need in order to populate the metadata your IdP (Identity Provider) requires. For example, if you put 'my-app', then your metadata will be at:
 
-<https://my-rocketchat-domain.tld/_saml/metadata/my-app>
+`https://my-rocketchat-domain.tld/_saml/metadata/my-app`
 
 ### Custom Entry Point (IDP SSO Redirect URL)
 
@@ -20,7 +20,7 @@ This is the URL provided by your IdP for logging out. In SAML-terminology, the i
 
 The URI that is the unique identifier of your service. By convention, this is also URL of your (unedited) metadata, again, where you set Custom Provider to 'my-app' this will be:
 
-<https://my-rocketchat-domain.tld/_saml/metadata/my-app>
+`https://my-rocketchat-domain.tld/_saml/metadata/my-app`
 
 ### Custom Certificate (IDP Signing Certificate)
 
@@ -42,7 +42,7 @@ You will have to send email field in your assertion or it will not work. If the
 
 As a popular open source IdP, SimpleSAMLphp can be used to provide an authentication endpoint for Rocket.Chat and the built in SAML support. Assuming you have a SimpleSAMLphp IdP up and running - [quickstart intructions here](https://simplesamlphp.org/docs/stable/simplesamlphp-idp) - you can find the metadata for the Rocket.Chat SAML Service Provider (SP) here, where 'my-app' is whatever you put in the 'Custom Provider' box in the Rocket.Chat SAML admin page:
 
-<https://my-rocketchat-domain.tld/_saml/metadata/my-app>
+`https://my-rocketchat-domain.tld/_saml/metadata/my-app`
 
 Copy the XML on this page, open the metadata converter page in your SimpleSAMLphp admin UI (which you'll find at `/admin/metadata-converter.php`), paste the XML and submit.
 

administrator-guides/create-the-first-admin/README.md

@@ -4,13 +4,11 @@ After you deploy your server, the first user to register becomes the administrat
 
 In case your server has no administrators, you can create the first admin account by defining the environment variables ADMIN_PASS and ADMIN_EMAIL once.
 
-```
-export ROOT_URL=http://your-host-name.com-as-accessed-from-internet:3000/
-export MONGO_URL=mongodb://localhost:27017/rocketchat
-export PORT=3000
-export ADMIN_USERNAME=admin
-export ADMIN_PASS=supersecret
-export [email protected]
-
-node main.js
-```
+    export ROOT_URL=http://your-host-name.com-as-accessed-from-internet:3000/
+    export MONGO_URL=mongodb://localhost:27017/rocketchat
+    export PORT=3000
+    export ADMIN_USERNAME=admin
+    export ADMIN_PASS=supersecret
+    export [email protected]
+
+    node main.js

administrator-guides/database-migration/README.md

@@ -12,26 +12,19 @@ Database migration may fail in these scenarios.
 
 A typical failure message is similar to:
 
-```
-|                    Your database migration failed:                   |
-|        Object [object Object] has no method 'addUsersToRoles'        |
-(...)
-|                   This Rocket.Chat version: 0.39.0                   |
-|                    Database locked at version: 18                    |
-|                      Database target version: 58                     |
-
-```
+    |                    Your database migration failed:                   |
+    |        Object [object Object] has no method 'addUsersToRoles'        |
+    (...)
+    |                   This Rocket.Chat version: 0.39.0                   |
+    |                    Database locked at version: 18                    |
+    |                      Database target version: 58                     |
 
 As an example, the above migration is locked and stuck on 18.  We need a target of 19 before migration to 58.
 
 One way to force migration is to manually unlock the migration in mongo and also increase database version to the target version (19).
 
-```
-
-use rocketchat
-db.migrations.update({_id: 'control'},{$set:{locked:false,version:19}})
-
-```
+    use rocketchat
+    db.migrations.update({_id: 'control'},{$set:{locked:false,version:19}})
 
 Restart Rocket.Chat and the migration should succeed now to the latest version.