Use Case

At The Crossing we use Rock as our CMS to power our external website. Along with this, we let ministry staff manage the web content for their specific ministries. We accomplished this by setting up content channels for each ministry and then using the Content Channel View and Content Channel Item View blocks on the site to display the formatted data.

The obvious challenge with this is making sure your ministry staff is well trained and can confidently manage their content. In our specific case we have some attribute fields that we don't intend ministry staff to edit, like a meta description our digital team is better suited to write. So to help our staff remember what each field is for as well as helping our digital team remember what tricky things they should look for before approving content we created user documentation for each content channel.

Guide

Start by creating a new content channel specifically for your documentation. You may only need one set of instructions, but in this example there will be multiple, one set for the ministry staff creating new items, and one for the digital team in charge of approving content before it is published on the site.

Next add a new attribute to the Content Channel section of any Content Channel Types you would like to have documentation on. Set the default channel to your documentation channel.

Set the attribute value on the content channel for its associated documentation.

Add a new HTML Block to the Content Channel Item Edit page with the Lava Command Rock Entity Enabled.

Write the Lava to display your documentation. Update the group ids in the lava to the applicable groups to your instance.

{% comment %}Get ID of the Content Channel Item that holds documentation{% endcomment %}

{% assign id = 'Global' | PageParameter:'ContentItemId' %}
{% contentchannelitem id:'{{id}}' %}
    {% assign cciid = contentchannelitem.ContentChannel | Attribute:'Documentation','Id' %}
{% endcontentchannelitem %}

{% comment %}Get Security Role{% endcomment %}

{% assign adminGroup = CurrentPerson | Group: "123",'Active' %}
{% assign isAdmin = adminGroup | Size %}
{% assign webAdminGroup = CurrentPerson | Group: "456",'Active' %}
{% assign isWebAdmin = webAdminGroup | Size %}
{% assign webEditorGroup = CurrentPerson | Group: "789",'Active' %}
{% assign isWebEditor = webEditorGroup | Size %}

{% if isAdmin > 0 or isWebAdmin > 0 or isWebEditor > 0 %}
    <div class='panel panel-default'>
        <div class='panel-heading'>
              <h1 class='panel-title'>
                  Instructions
              </h1>
        </div>
        <div class='panel-body'>
            {% if cciid != '' and cciid != null %}
                {% contentchannelitem id:'{{cciid}}' %}
                    {{contentchannelitem | Attribute:'UserInstructions'}}
                    {% if isAdmin > 0 or isWebAdmin > 0 %}
                        {{contentchannelitem | Attribute:'WebAdminInstructions'}}
                    {% endif %}
                {% endcontentchannelitem %}
            {% endif %}
        </div>
    </div>
{% endif %}

Now you should have some nice instructions over your content channel item edit section.