Rocket.Chat Is Moving Its Documentation To Gitbook

Martin Schoeler
May 21, 2020
min read

After careful consideration, Rocket.Chat is officially moving its documentation to GitBook.With this change, we expect to improve the rate of which we develop, fix, and maintain documentation by making sure everyone on the team can edit it easily.Previously, we used Jekyll for documentation purposes. However, as time passed, we faced more and more issues with Jekyll, such as:The necessity of running the server locally in order to preview changes (which required some basic development knowledge). It required constant UI maintenance, always falling behind the website somehow. Lack of capabilities to search through different versions of the same feature.Therefore, we've decided to move to Gitbook which provides a more user-friendly and collaborative product for everyone.We hope this change will boost the adoption of writing documentation among our developers. Besides that, we aim to increase the speed of UI maintenance, which will enable us to allocate more time to writing documentation and keep our processes up to date.

What Does This Mean To Our Community?

As you can see, moving our documentation will be a whole new scenario for our development team. However, we predict minor impacts on our current contribution flow.As to our community contributions, it will still be necessary to create pull requests in our docs repository, but we will lighten up some of the tests we were running.It is worth mentioning that this switch to Gitbook will change the structure of our documentation significantly. Previously, we had a structure that consisted of various named folders with files. From now on, folders will only be kept there if there is more than one file in that category, and the file will act as an index of that folder. The rest will be named .md files.As to the current pull requests flow on our docs repository, at first they might be impacted, but our team is ready to help solve these conflicts.If you have questions, feel free to reach out to us through our channel we will be happy to help!

Get started with Rocket.Chat’s secure collaboration platform

Talk to sales

Frequently asked questions about <anything>

Martin Schoeler
Related Article:
Team collaboration: 5 reasons to improve it and 6 ways to master it
Want to collaborate securely with your team?
Deploy Rocket.Chat on-premise or in the cloud and keep your conversations private.
  • Digital sovereignty
  • Federation capabilities
  • Scalable and white-labeled
Talk to sales
Looking for a HIPAA-ready communications platform?
Enable patients and healthcare providers to securely communicate without exposing their data.
  • Highly scalable and secure
  • Full patient conversation history
  • HIPAA-ready
Talk to sales
The #1 communications platform for government
Deploy Rocket.Chat on-premise, in the cloud, or air-gapped environment.
  • Secure data governance and digital sovereignty
  • Trusted by State, Local, and Federal agencies across the world
  • Matrix federation capabilities for cross-agency communication
Talk to sales
Want to customize Rocket.Chat according to your own preferences?
See behind the engine and change the code how you see fit.
  • Open source code
  • Highly secure and scalable
  • Unmatched flexibility
Talk to sales
Looking for a secure collaboration platform?
Keep your conversations private while enjoying a seamless collaboration experience with Rocket.Chat.
  • End-to-end encryption
  • Cloud or on-prem deployment
  • Supports compliance with HIPAA, GDPR, FINRA, and more
Talk to sales
Want to build a highly secure in-app chat experience?
Use Rocket.Chat’s APIs, frameworks, and managed backend to build a secure in-app or live chat experience for your customers.
  • Supports compliance with HIPAA, GDPR, FINRA, and more
  • Highly secure and flexible
  • On-prem or cloud deployment
Talk to sales

Our best content, once a week

Share this on:

Get your free, personalized demo now!

Build the most secure chat experience for your team or customers

Book demo