Skip to content

Commit

Permalink
Some doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
dleffler committed Oct 5, 2012
1 parent 339fd57 commit 23fc5cd
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 17 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ Added / Fixed / changed for 2.1.0
# This release focuses on upgrading calendar module to a 2.0 controller.
Implementing some forms modules features/possibly move it to 2.0. Making e-Commerce a better OOTB experience.
Begin more graceful integration of jQuery/Twitter Bootstrap, etc...
- adds optional nested comments, and optional per-item comment disabling
- adds optional comments to filedownload module
- adds pagination option of 'More', useful for sidebar views
- removes extra themes to reduce size of package, available as separate addon download

Added / Fixed / changed for 2.0.9
-----------------------
Expand Down
22 changes: 16 additions & 6 deletions INSTALLATION
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ Requirements

Upgrading / Migrating
If you are upgrading, it is HIGHLY RECOMMENDED that you export your database and back up your files.
Upgrading from 1.0 (0.98 currently) to 2.0 isn't an upgrade, but a migration. Refer to to documentation on migrating content from 1.0 to 2.0.
Upgrading from 1.0 (0.98 currently) to 2.0 isn't an upgrade, but a migration. Refer to to documentation on migrating
content from 1.0 to 2.0.

---------------------

Expand All @@ -26,11 +27,20 @@ Upgrading from 1.0 (0.98 currently) to 2.0 isn't an upgrade, but a migration. Re
- This can be locally if you have a web server installed on your computer, or on any number of linux-based hosts.

3. Database Setup
- For security reasons, the Exponent Install Wizard is not able to create a database for you. This must be done outside of the system, before the wizard is run. However you do this is up to you (through command-line database client, phpMyAdmin, etc.). The installer will ask you for name of the database to use, as well as a username and password for accessing the database. The user account you specify must have enough rights to perform normal database operations (like running SELECT, INSERT, UPDATE, DELETE queries, etc.). The installation wizard will ensure that the provided account has these privileges.

4. Run the Install Wizard
- Once the directory is on the server, in the website's directory, the web-based installer takes over the process of configuring and setting up the CMS. To access the installer and finish setting up, visit your website, and go to the directory that was unpacked. For instance, if your website (www.example.com) stores its files in ~/public_html/, and you unpacked the archive there, go to http://www.example.com/.
- From there, just follow the instructions and the Exponent Install Wizard will configure and set up your new Exponent site.
- For security reasons, the Exponent Install Wizard is not able to create a database for you. This must be done
outside of the system, before the wizard is run. However you do this is up to you (through command-line database
client, phpMyAdmin, etc.). The installer will ask you for name of the database to use, as well as a username and
password for accessing the database. The user account you specify must have enough rights to perform normal
database operations (like running SELECT, INSERT, UPDATE, DELETE queries, etc.). The installation wizard will
ensure that the provided account has these privileges.

4. Run the Install/Upgrade Wizard
- Once the directory is on the server in the website's directory, the web-based installer takes over the process
of configuring and setting up the CMS. To access the installer and finish setting up, visit your website, and go to
index.php file in the install folder. For instance, if your website (www.example.com) stores its files in
~/public_html/, and you unpacked the archive there, go to http://www.example.com/install/index.php.
- From there, just follow the instructions and the Exponent Install/Upgrade Wizard will configure and set up your
new Exponent site.

5. Enjoy using Exponent!

Expand Down
14 changes: 6 additions & 8 deletions README
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Exponent Content Management System
#Exponent Content Management System
Copyright (c) 2004-2012 OIC Group, Inc.
===============================================

Expand All @@ -16,13 +16,13 @@ completely customize the layout, and delegate responsibilities to other
users.

----------------
Getting Started
##Getting Started

First, you'll need to install and configure Exponent. See the INSTALLATION
file for a detailed description of how to do this.

------------
Contributing
##Contributing

Exponent is Open Source, licensed under the GPL. To read about the
specifics of the GPL, please see the LICENSE file.
Expand All @@ -36,7 +36,7 @@ are encouraged to join in. Simply fork this repository, hack away, and submit
a pull request. We'll take a look at your code and changes

* Documentation - If you're interested in helping with documentation,
contact us: https://github.com/inbox/new/exponentcms and we'll advise you
contact us through the forums http://forums.exponentcms.org and we'll advise you
as to where to contribute documentation.

* Testing - As with every software application, there are bound to be
Expand All @@ -45,10 +45,8 @@ looking for more testers; people to use and abuse the CMS and expose bugs.
The more bugs we find and fix, the better off the package is.

-------------------
Support / Questions
##Support / Questions
For questions, support, or further information, please visit
http://www.exponentcms.org/
https://github.com/inbox/new/exponentcms
http://forums.exponentcms.org/


http://docs.exponentcms.org/
4 changes: 2 additions & 2 deletions phpdoc.ini
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
[Parse Data]
;; title of all the documentation
;; legal values: any string
title = Exponent 2.0.9 API Documentation
title = Exponent 2.1.0 API Documentation

;; parse files that start with a . like .bash_profile
;; legal values: true, false
Expand Down Expand Up @@ -88,7 +88,7 @@ directory = .
;; legal values: any wildcard strings separated by commas
;; remember, this pathing is RELATIVE to the top-most directory in your "directory" value
;ignore = path/to/ignore*,*list.php,myfile.php,subdirectory/
ignore = external/,tmp/,framework/modules/pixidou/,framework/modules/news/models/SimplePie.php
ignore = external/,tmp/,framework/core/lang/,framework/modules/pixidou/,framework/modules/news/models/SimplePie.php

;; comma-separated list of Converters to use in outputformat:Convertername:templatedirectory format
;; legal values: HTML:frames:default,HTML:frames:l0l33t,HTML:frames:phpdoc.de,HTML:frames:phphtmllib,
Expand Down
2 changes: 1 addition & 1 deletion phpdoc.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8" ?>
<phpdoc>
<title>Exponent 2.0.9</title>
<title>Exponent 2.1.0</title>
<parser>
<default-category-name>API Documentation</default-category-name>
<default-package-name>Framework</default-package-name>
Expand Down

0 comments on commit 23fc5cd

Please sign in to comment.