Customising the Getting Started Guide on the Dashboard

By default, the Confluence dashboard displays a quick-start guide for administrators under the site welcome message on the left. This section of the dashboard is visible to Confluence administrators and system administrators only. It is not configurable via the web interface, but you can update or remove it by editing the site layout as described below.

You need System Administrator permissions to perform this customisation.

Editing or removing the getting-started section

To customise the getting-started guide on the dashboard:

  1. Choose the cog icon , then choose General Configuration under Confluence Administration.

  2. Choose Layouts in the left-hand panel.
  3. Choose Create custom (or Edit) next to Global Layout.
    Note: If the global layout has already been customised, the 'Edit' option will be available. Otherwise, you will need to create the custom layout now, by choosing 'Create custom'.
  4. Find the following code:

    #if($permissionHelper.isConfluenceAdministrator($remoteUser))
                        <div class="dashboard-item wiki-content">
                            <h2>$i18n.getText("getstarted.heading")</h2>
                            <ol id="dashboard-get-started">
                                <li class="create-space">
                                    <h3><a href="$req.contextPath/spaces/createspace-start.action">$i18n.getText("getstarted.add.space")</a></h3>
                                    <p>$i18n.getText("getstarted.add.space.desc")</p>
                                </li>
                                <li class="add-users">
                                    <h3><a href="$req.contextPath/admin/users/browseusers.action">$i18n.getText("getstarted.add.users")</a></h3>
                                    <p>$i18n.getText("getstarted.add.users.desc")</p>
                                </li>
                                <li class="user-profile">
                                    <h3><a href="$req.contextPath/users/editmyprofilepicture.action">$i18n.getText("getstarted.choose.profile.picture")</a></h3>
                                    <p>$i18n.getText("getstarted.choose.profile.picture.desc")</p>
                                </li>
                            </ol>
                        </div>
                        #end
  5. Update the code as required:
    • To remove the 'get started' section, delete the entire block of text shown above.
    • Alternatively, edit the code to suit your requirements. See Customising Site and Space Layouts for guidelines.
  6. Choose Save.

The default getting-started section

By default, the getting-started guide looks more or less like the screenshot below, starting with the heading 'Get started'.

To restore the default getting-started guide:

  1. Choose the cog icon , then choose General Configuration under Confluence Administration.

  2. Choose Layouts in the left-hand panel.
  3. Choose Reset Default next to Global Layout.
    Note: This well reset any other customisations applied to this layout too.

Screenshot: The getting-started guide on the dashboard

Notes

If you modify the look and feel of Confluence by following these instructions, you will need to update your customisations when upgrading Confluence. The more dramatic the customisations are, the harder it will be to reapply your changes when upgrading. Please take this into account before proceeding with your customisation. For more information on updating your customisations, please refer to Upgrading Customised Site and Space Layouts.

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport