Skip to content

Latest commit

 

History

History
110 lines (70 loc) · 6.08 KB

CONTRIBUTING.md

File metadata and controls

110 lines (70 loc) · 6.08 KB
Raw

Documentation Contribution Guidelines

First of all, thank you for your interest in contributing to Rocket.Chat Docs. If this is the first Open Source project you will contribute to, we strongly suggest reading GitHub's excellent guide "Contributing to Open Source".

Finding something to work on

When looking for something to work on, you have two options:

1. The Documentation Map

You can find a map of all the files on the documentation here. There you can find what articles are missing or incomplete. This page was created so is easier for the Rocket.Chat team and the community to know the status of the documentation and what they can do to improve it.

Missing articles will be marked as red

Incomplete articles will be marked as orange

All missing/incomplete articles are links to a list with the description of each article marked on the documentation map (you can find this list here)

2. Issues

You can find a list of issues here. 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

Requirements

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 and remove the topic from the Missing/Incomplete Article List (if necessary).
  • If a file is created or moved, you need to update the Table of Contents (You can find the file here).
  • 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.
  • 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.
  • We also use a linter tool to check if the style of the markdown matches our styleguide. Here is a link to the Markdown Linter Tool.

Recommended Workflow

When making small changes like typos and such, there is no problem to edit the file directly on GitHub, but if you are making bigger changes or adding new files to the docs, we recommend following this workflow

  • 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 with gem install mdl.
  • Fork the appropriate repository to your account.
  • This is usually here.
  • Clone your fork.
  • Run bundle install.
  • Start the server with bundle exec "jekyll serve --incremental --safe".
  • Before starting read our Markdown Style Guide.
  • Make your changes locally.
  • Run the markdown linter tool with mdl . on the root directory of the project.
  • Run bundle exec "rake check_links" with the server running to check for broken links.
  • Commit your changes to a new branch.
  • Push that branch to your repository.
  • Open a PR.
  • Make sure you include a description of why you're making the changes.

Table of Contents

Every time you add a new file to the documentation, you will have to add it to the table of contents.

The table of contents is the left navigation sidebar, and it is the way others will find your new article.

You can find the table of contents .yml file here.

You have to note that the name you put on the table of content will be slugfied, and these names will be used to search for that file.

E.g.

If you add a page called Testing Rocket.Chat Apps, it will be converted to testing-rocketchat-apps, so you will have to name your file testing-rocketchat-apps.md

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

When you find a problem on the documentation and want to report it to us you have some alternatives:

Documentation Map

If you find that a document either is missing from the docs or is incomplete or outdated, we would recommend that you create a Pull Request adding the missing/incomplete document to the Documentation Map.

To add a document to the documentation map you can simply add a new item to the tree map in here.

For a missing document you should add

<span class="missing">[NAME OF YOUR DOCUMENTATION](../missing-and-outdated-list/#TITLE ON THE MISSING LIST)</span>

For a incomplete document you should add

<span class="incomplete">[NAME OF YOUR DOCUMENTATION](../missing-and-outdated-list/#TITLE ON THE MISSING LIST)</span>

After that you will have to write an explanation of how this document should be, or what is the problem with it on the Missing our Outdated Docs and link this topic after the # on the link you just added to the Documentation Map.

Incomplete articles are the ones that are missing a big part of information in them, so if a article is missing a little bit of information, it shouldn't be added to the incomplete list

Bugs, typos, markdown syntax and such should not be listed on this map

We understand that not everyone has the time to create Pull Requests so feel free to create regular issues too.