25 March, 2018

Last week we had a remote sprint to improve documentation, and wow, what a success it was!

Progress

  • The sprint was focused on improving the User Guide.
  • Check out everything we did.

  • GitHub tells us:

    Excluding merges, 14 authors have pushed 86 commits to master and 88 commits to all branches. On master, 206 files have changed and there have been 1,182 additions and 1,917 deletions.

    Wow!

  • Notably, we made significant progress on adding cross-references to improve navigation and discoverability (though there's still some more work to do here).

  • Furthermore, some people also did some work on...

Read more
20 February, 2018
Filed under Community, Documentation

The Documentation Working Group is planning a remote sprint to improve content in the User Guide. Everyone is invited to participate! Experience editing our docs will be helpful but not required.

Sign up to join this sprint

Time frame

We've chosen one 72-hour block for the sprint as follows. Mark your calendars, and join us for however much time you like during this window.

Time Zone   Start End
LA Wednesday, March 21 at 6 pm Saturday, March 24 at 6 pm
Denver Wednesday, March 21 at 7 pm Saturday, March 24 at 7 pm
Chicago Wednesday, March 21 at 8 pm...
Read more
14 November, 2017

Two months ago, I launched a Make It Happen campaign to build a System Administrator Guide with the goal of migrating the installation, setup, and upgrade documentation out of the wiki and into a beautiful guide on our new documentation platform. Amazingly, the MIH campaign reached its $2,000 USD minimum in only 4 days — which meant I could get to work right away!

Now I've completed this content migration and am excited to share the System Administrator Guide with you, in all its glory...

https://docs.civicrm.org/sysadmin

Thanks

Before you thank me, join me in thanking these partners and community members who made this project happen by backing the campaign:

Read more
13 September, 2017

Are you a system administrator who installs, configures, upgrades, or integrates CiviCRM?

Have you noticed how awesome the new User Guide and Developer Guide are, but felt sad that the system administrator docs have been left out of the party, languishing in the wiki?

Your time has come! A System Administrator Guide will soon be on its way! ... hopefully...

I've just launched a Make It Happen campaign to build the System Administrator Guide. If I can raise $2,000 USD by October 15th, I will migrate the installation, setup, and upgrade documentation out of the wiki and into a beautiful guide on our new documentation platform.

...
Read more
21 July, 2017

CiviCooP and Systopia and Palasthotel have been working together on CiviProxy and CiviProxy. This blog is a round up of what we have achieved in the last couple of days. The first thing we have achieved is that we had fun and a very good work atmosphere. We made long days and made lots of progress.

What are CiviProxy and CiviMcRestFace?

CiviProxy is a script to act as an application firewall for CiviCRM. It could be used to put your civicrm in secure network. CiviProxy is the gatekeeper to which external systems, such as your website, connect (this is for example when a user signs a petition on your website and the website submits this data to your CiviCRM). CiviProxy will make sure the call is from the right place (ip-adress) and is only doing what allowed to do. 

CiviMcRestFace (CiviMRF) is a framework to be used in other systems (such as your external website) to connect to CiviCRM. The framework itself is...

Read more
17 February, 2017
By lolcode
Filed under Documentation

Just a heads up for the community that "Using CiviCRM" by Joe Murray and Brian Shaughnessy is Packt Publishing's free book of the day. See https://www.packtpub.com/packt/offers/free-learning.

This book is a good overview of the system despite being written for a much older version of CiviCRM. In particular the early chapter on planning your CRM implementation is still applicable and valuable information that is often overlooked.

Packt Publishing also has a second edition available at: https://www.packtpub.com/web-development/using-civicrm-second-edition and a cookbook  at https://www.packtpub.com/web-development/civicrm-cookbook

 

12 January, 2017
Filed under Community, Documentation

TL;DR: A migration project is underway to bring wiki content into the Developer Guide.

The wiki is kind of like that drawer in your kitchen where you put things that seem useful but don't really have "a place". And it works okay, especially when its your kitchen, because you have a decent idea of what you've chucked in there over the years.

Hi my name is Sean and I'm an aspiring CiviCRM developer. After many years as a CiviCRM user and administrator, I've carved out some time in my life to effectively "go to school" on CiviCRM development. Last month, I got started by diving into reading the wiki, hoping it would serve as my text book. But instead I found someone else's kitchen drawer filled with – useful things, for sure – but also that familiar medley of...

Read more
20 April, 2016
Filed under Documentation

We've built a new home for CiviCRM's documentation. Here's a quick run down of what we've done, why we've done it, and how you can help with the move.

First, a quick recap of our documentation's long and illustrious history:

Pretty much all our documentation started long ago on our trusted wiki. Our wiki is great, but like all wikis, a bit messy and a bit incomplete.  A few years later (starting in 2009) a concerted effort was made to 'finish' our user documentation - to write a complete book on how to use CiviCRM, the result of which was the CiviCRM user guide, hosted on a different platform: Flossmanuals. Flossmanuals was very good to us. We were able to complete a book that covers pretty much everything that you can do via the user interface, which was a big step forward. And it got us in the habit of running one or two books sprints a year, which has enabled us to keep our user documentation up to date with each release (woo!). But Flossmanuals has had...

Read more
17 March, 2016
By JonGold
Filed under Community, Documentation

If you haven't checked it out yet, the CiviCRM Stack Exchange is a Q&A site where folks can get free support for using CiviCRM.

It's simple to use - ask a question, get answers.  Users vote on both questions and answers, and there's no chit-chat, just answers.  You earn reputation points when people vote for your questions and answers.  Many top CiviCRM experts use the site and answer questions.

If you're looking for a way to support the CiviCRM community with minimal investment, using the site is a great way to do it!  Asking a good question - or upvoting someone else's good answer - both help to improve the quality of CiviCRM support.  We're also looking to increase our Stack Exchange traffic so our site is promoted to the top tier of exchanges.  So if you've visited before, now's a great time to visit again.

Take a look today - take the 60 second tour or...

Read more
03 October, 2015
Filed under Documentation

A while ago I did a test migration of CiviCRM's user and admin documentation to gitbook and said that I'd also do a migration to readthedocs so we could compare the two.  I finally got round to completing the readthedocs migration so wanted to share with you some impressions so far, the advantages and disadvantages are of both systems.

Spoiler alert: At the moment, I think we should go with readthedocs. If you're interested in the reasons and the gory details, keep on reading - I would love you have your thoughts and opinions.

Most of the work consisted of creating a script to convert from gitbook to readthedocs. It's not pretty but it works and means that if we decide to go with readthedocs, it will be simple for us to convert the latest gitbooks version over to readthedocs (and that we can continue editing the book in gitbook format until we...

Read more