Skip to content

Commit

Permalink
docs(admin): Migrated Getting Started guide from wiki.
Browse files Browse the repository at this point in the history
Refs #6812.
  • Loading branch information
brettp committed Sep 27, 2014
1 parent 914fa69 commit 11e589f
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 6 deletions.
35 changes: 35 additions & 0 deletions docs/admin/getting_started.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
Getting Started
###############

You have installed Elgg and worked through any potential initial issues. What now? Here are some
suggestions on how to to familiarize yourself with Elgg.

Focus first on core functionality
=================================

When you're new to Elgg, it's best to explore the stock features in core and its bundled plugins before installing any third party plugins. It's tempting install every interesting plugin from the community site, but exploring the core features builds a familiarity with Elgg's expected behavior, and prevents introducing any confusing bugs from third party plugin into your new Elgg network.

Elgg installs with a basic set of social network plugins activated: blogs, social bookmarking, files, groups, likes, message boards, wiki-like pages, user profiles, and microblogging. To change the plugins that are activated, log in as an admin user, then use the topbar to browse to Administration, then to Plugins on the right sidebar.

.. note:: The user you create during installation is an admin user.

Create test users
=================
Users can be created two ways in stock Elgg:

#. Complete the signup process using a different email address and username. (Logout first or use a different browser!)
#. Add a user through the Admin section by browsing to Administration -> Users -> Add New User.

.. note:: Users that self-register must validate their account through email before they can log in. Users that an admin creates are already validated.

Explore user functionality
==========================
Use your test users to create blogs, add widgets to your profile or dashboard, post to the Wire (microblogging), and create pages (wiki-like page creation). Investigate the Settings on the topbar. This is where a user sets notification settings and configures tools (which will be blank because none of the default plugins add controls here).

Explore admin functionality
===========================
All of the admin controls are found by clicking Administration in the topbar. The has a dashboard with a widget that explains the various sections. Change options in the Configure menu to change how Elgg looks and acts.

Extending Elgg
==============
After exploring what Elgg can do out of the box, install some themes and plugins. You can find many plugins and themes at the community site that have been developed by third parties. These plugins do everything from changing language strings, to adding chat, to completely redesigning Elgg's interface. Because these plugins are not official, be certain to check the comments to make sure you only install well-written plugins by high quality developers.
13 changes: 7 additions & 6 deletions docs/admin/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ Administrator Guides
Best practices for effectively managing an Elgg-based site.

.. toctree::
:maxdepth: 1

upgrading
plugins
performance
cron
:maxdepth: 1

getting_started
upgrading
plugins
performance
cron

0 comments on commit 11e589f

Please sign in to comment.