System Administrator Guide

Migrate the installation, setup and upgrade documentation out of the wiki and into a beautiful guide on our new documentation platform.
October 15, 2017

Campaign basics

  • Minimum: $2,000 USD
  • Two ways to back this campaign:
    • Donate now if you trust the campaign will succeed. (If the campaign fails to meet the minimum before the deadline, the project will not be implemented and your donation will go towards CiviCRM LLC.)
    • Pay later to pledge a payment you will deliver only if this campaign is funded.

Sept 17th Update: 100% funded!

Thanks to the generous support of these service providers and community members, this MIH campaign reached its target in under 4 days!

Keep an eye on the GitHub project repository, and stay tuned to the blog and documentation chat room for more updates.

We need a System Administrator Guide

For about a year and a half, community members have been slowly migrating CiviCRM documentation to a new system on which uses MkDocs to build awesome guides. It blows the wiki out of the water! The User Guide and Developer Guide are now fully migrated and providing vital, time-saving information to users and developers. Hooray!

But something is missing... you'll still need to wade through the wiki to learn about topics like: installation, setup, and upgrades. The wiki is messy, hard to navigate, and even harder to maintain. For almost two years, community members have been planning to port this content to MkDocs by building a System Administrator Guide. Still, no one has begun working on this project.

I will build the System Administrator Guide... if you support this campaign.

This campaign will deliver it

I've already created a GitHub repository for the guide and used it to create a planned outline, which several community members have endorsed.

This campaign will migrate existing content into the guide, from the wiki and some other sources as needed.

My planned outline does include a few pages on topics that don't already have any content anywhere. For example, there's no page on "data redaction" in the wiki. In these (very few) cases, I will provide placeholder pages and GitHub tickets to track the future work of writing this content. Like CiviCRM, the guide will never be "done" and always a work in progress. But this campaign will kickstart it by delivering a product which shifts system administrators away from the wiki and into docs that feel comprehensive and polished.

After this campaign is funded, when can you expect to have the Sysadmin Guide within three months.


-- placeholder --