New SuiteCRM Documentation site

New SuiteCRM Documentation site

https://docs.suitecrm.com

Hey everyone, We are pleased to announce the new Documentation site! It is the new place where you can view and contribute to the SuiteCRM documentation.

The old wiki will soon be removed.

More and better Content

  • the new site includes the Developer Guide which is the full content of Jim Mackin’s “SuiteCRM for Developers”. A big “thank you” to Jim for this!
  • documentation for recent features in 7.9 and 7.10: the new email module, Campaigns, REST API v8 and Surveys
  • more improvements will follow (to the installation Guide, for example)
  • a Technical Blog will regularly provide tips and how-tos. For the first months, we will be using already existing content from various SuiteCRM Blogs out there who gave us permission. Eventually new content will be produced.
  • site is ready to be multi-lingual, although the other language versions will come slowly and progressively

Improved Process

  • the site uses new and exciting technologies to make cooperation easier. From the simplest edits to large documentation translation projects, the tools are in place to make things happen
  • non-technical users can propose edits in just three clicks

People with more technical inclinations can take advantage of the architecture:

  • GitHub based: we can use our existing user accounts, discuss documentation Issues in an organized fashion, have multiple branches
  • Static-site technology based on Hugo engine
  • Asciidoc-based markup, great for human readability and extensibility
  • Automated deployment via Netlify, we can browse content from every branch, not just “master”, so we can preview changes to the site before they go live
  • you can contribute not only content, but also Documentation site features (written in Go language).

Easier to contribute

The new documentation site is designed to make it very easy to contribute to. Community members that don’t have coding experience can participate in the project and contribute to the documentation. By sharing knowledge, and adding content and translating the guides, you can help SuiteCRM grow to become world’s most used and loved CRM!

3 Likes

I wrote some tutorials for people who want to start contributing right away :slight_smile:

http://docs.suitecrm.com/community/contributing-to-docs/