Read Me

//    Constant - Change Management
//    Copyright (C) 2008  Crosstown Traders, Inc.
//
//    This program is free software: you can redistribute it and/or modify
//    it under the terms of the GNU General Public License as published by
//    the Free Software Foundation, either version 3 of the License, or
//    (at your option) any later version.
//
//    This program is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//    GNU General Public License for more details.
//
//    You should have received a copy of the GNU General Public License
//    along with this program.  If not, see <http://www.gnu.org/licenses/>.

Constant was designed to be a simple mechanism to manage organizational changes. It was written with groups of users in mind. 

For each change that needs to be completed, a representative from that group will create a change entry. A representative from each other group has the opportunity to review and approve/disapprove/request info for each change. 

Constant logs all approves/disapproves and edits in the interest of transparency. Each group can see what the other groups are doing, and who is reviewing items. The intent is that these groups get together on a semi-regular basis to review outstanding changes together.

################################################################################
Accounts
################################################################################
--------
Each user registers their own account and can reset their password, or edit their groups in the [MyAccount] page. 

The site admin can flag any user as an admin. As an admin, there are additional menu options available: 
	*[Users]* - Used for maintaining and editing accounts
	*[Groups]* - Used for adding/removing Groups
	*[Clear Table Locks]* (To be removed in future) - Can be used if records are locked for editing and are not freed.

################################################################################
Changes
################################################################################
-------
Each change is assigned a unique identifier. Each change tracks its last edit and approvals etc. 
	Status: Can be Open, Closed, Hold, or Cancel - This can be used to track which changes are still in flight, or completed etc
	Severity: 1,2,3 - What is the urgency of this change?
	Risk: What is the impact to the environment? High, Medium, Low?
	Date/Time: When will this be implemented
	Description: 
	Impacted Systems: What other processes/systems may be involved with this change?
	Implementation Summary: The game plan for the change
	Backout Plan: You should probably have one!
	Notes: Any misc information

	Implementation Notes: Did some things not go according to plan? Make notes here
	Implementation Date: When did you actually complete this?
	Results: Success/Failure

Note on approvals: Users can only edit approvals for Changes in their own group. This way we can keep some accountability. Additionally, all approvals display names and times.

################################################################################
Reports
################################################################################
-------
Different ways to display lists of changes so that you can keep track of workload or what's been done, or what's languishing.

################################################################################
User List
################################################################################
---------

Looking for someone from a specific group to approve a change? Try the [User List]!


################################################################################
# CONFIG FILE
################################################################################

The config file is located at includes/config/config.php. The variable names should be fairly straightforward, but in case they arent, they are listed here:

$GLOBALS[site_name] - The Name for your site which appearst appears in the title bar of the browser.

$GLOBALS[version] - The version of Constant that is running

$GLOBALS[poweredby] - The powered by string shown at the bottom of the footer (includes/layout/footer.php)

$GLOBALS[blurb] - The tagline displayed under the Constant banner in the header (includes/layout/header.php)

$GLOBALS[welcome] - The Welcome string displayed at the top of the home page (index.php)

$GLOBALS[home] - This URL is used for all "Continue" and "Home" links

$GLOBALS[backgroundcolor] - Sets main page backgroun in the stylesheet (styles/style.css)

$GLOBALS[tagline] - Displayed right under the main content table. Controlled by the footer (includes/layout/footer.php)

$GLOBALS[admin_email] - Used for "Contact" Links

$GLOBALS[database_host] - The IP or hostname of the machine with your MySQL instance (used in includes/boilerplate.php)

$GLOBALS[database_name] - The name of the database you created for Constant to use

$GLOBALS[database_user] - The username to log into the database with

$GLOBALS[database_password] - The password to use when logging into the database

$GLOBALS[header_image] - The image to use at the top of the page in the header (includes/layout/header.php)

$GLOBALS[separator_image] - The image to use to offset parts of the page