a few edits
authorgreg gay <ggay@ocad.ca>
Thu, 29 Jun 2006 23:54:16 +0000 (23:54 -0000)
committergreg gay <ggay@ocad.ca>
Thu, 29 Jun 2006 23:54:16 +0000 (23:54 -0000)
docs/documentation/developer/guidelines.html

index 70ad2c3..3092fc6 100644 (file)
@@ -259,9 +259,15 @@ register_argc_argv   = Off</pre></p>
                <p>For repository URL, enter <kbd>http://atutorsvn.atrc.utoronto.ca/repos/atutor/trunk</kbd>. If you enter a folder name that does not yet exist, a directory with that name will be created. Press "OK", and the source will be downloaded to your computer.</p>\r
 \r
                <p>For non-Windows users, download an appropriate SVN package from the <a href="http://subversion.tigris.org/project_packages.html" title="Subversion packages">Subversion homepage</a> and follow the installation instructions. These packages use the command-line client. Checking out the most recent ATutor source code can be done with the following command: <kbd>svn checkout http://atutorsvn.atrc.utoronto.ca/repos/atutor/trunk</kbd>.</p>\r
-\r
+               <p>The checkout includes:</p>\r
+               <ul>\r
+                       <li><kbd>bundle.sh</kbd> - Execute this shell script to generate an installable bundle of the ATutor.</li>\r
+                       <li><kbd>docs/</kbd> - The ATutor source code</li>\r
+                       <li><kbd>mods/</kbd> - Extra module source code</li>\r
+               </ul>\r
+               <p>Extra modules can also be checked out into the ATutor <kbd>mods/</kbd> directory, from where they can be easily installed using the ATutor administor's Install Modules tool. See the <a href="modules.html">ATutor Module Documentation</a> for more about creating and modifying modules. From within the <kbd>docs/mods/</kbd> directory of your development version of ATutor, use  <kbd>svn checkout http://atutorsvn.atrc.utoronto.ca/repos/atutor/trunk/mods/[module_name]</kbd>.</p>\r
        <h3><a name="svn-installing_atutor"></a>4.2 Installing ATutor From SVN</h3>\r
-               <p>Before starting the installation process you should create an empty <kbd>`config.inc.php`</kbd> file in the <kbd>`include/`</kbd> directory: use <kbd>touch config.inc.php</kbd> on UNIX. Browse to the location of your checked out files in a web browser and proceed with the ATutor installation instructions. This will set up the database and user accounts for your ATutor system. The resulting ATutor installation will be your developing environment.</p>\r
+               <p>Before starting the installation process you should create an empty <kbd>`config.inc.php`</kbd> file in the <kbd>`include/`</kbd> directory: use <kbd>touch config.inc.php</kbd> on UNIX. Browse to the location of your checked out files in a web browser and proceed with the ATutor installation instructions. This will set up the database and user accounts for your ATutor system. The resulting ATutor installation will be your development environment.</p>\r
 \r
        <h3><a name="svn-update"></a>4.3 Updating ATutor From SVN</h3>\r
                <p>You should periodically perform updates from the repository to make sure you are working with the developers' latest files. To do this with TortoiseSVN, right click on the working folder and select "Update" from the context menu. For command-line svn clients, use: <kbd>svn update</kbd>.</p>\r
@@ -277,11 +283,11 @@ register_argc_argv   = Off</pre></p>
 \r
 <a href="#top" class="top">top</a>\r
 <h2><a name="communication"></a>5. Communication</h2>\r
-       <p>All communication between developers should occur in the <a href="http://lists.sourceforge.net/lists/listinfo/atutor-devel">mailing list</a> or the <a href="http://atutor.ca/forum/12/1.html">developer forum</a>. Please try to keep discussions public including any feature proposals.</p>\r
+       <p>All communication between developers should occur in the <a href="http://atutor.ca/forum/12/1.html">Development Forum</a>. Please try to keep discussions public including any feature proposals.</p>\r
 \r
 <a href="#top" class="top">top</a>\r
 <h2><a name="patches"></a>6. Patches</h2>\r
-       <p>Patches should be applied using the UNIX <kbd>patch</kbd> command. Make sure your <kbd>`.patch`</kbd> or <kbd>`.diff`</kbd> files will be compatible or send explicit instructions on how to apply your changes. Always specify what release or source date you are patching against. We prefer unified diffs. Diffs can be sent via the <a href="http://lists.sourceforge.net/lists/listinfo/atutor-devel">mailing list</a>.</p>\r
+       <p>Patches should be applied using the UNIX <kbd>patch</kbd> command. Make sure your <kbd>`.patch`</kbd> or <kbd>`.diff`</kbd> files will be compatible or send explicit instructions on how to apply your changes. Always specify what release or source date you are patching against. We prefer unified diffs. Diffs can be posted as attachment to the atutor.ca <a href="http://www.atutor.ca/forum/12/1.html">Development Forum </a>.</p>\r
 \r
 <a href="#top" class="top">top</a>\r
 <h2><a name="editor-tips"></a>7. Editor Tips</h2>\r
@@ -305,7 +311,7 @@ register_argc_argv   = Off</pre></p>
 \r
 <a href="#top" class="top">top</a>\r
 <h2><a name="bug-tracking"></a>9. Bug Tracking</h2>\r
-       <p>Please report bugs to the <a href="http://atutor.ca/forum/3/1.html" title="ATutor.ca - Bug Forum">ATutor Bug Reports</a> forum. Be sure to indicate the code version being used, such as a release candidate, stable release, nightly build, or SVN checkout, etc. Also be sure to describe the details of the system that ATutor is being developed or tested on, such as the operating system, web server and version, PHP version, etc.</p>\r
+       <p>Please report bugs to the <a href="http://atutor.ca/forum/3/1.html" title="ATutor.ca - Bug Forum">ATutor Bug Reports</a> forum. Be sure to indicate the code version being used, such as a release candidate, stable release, nightly build, or SVN checkout, etc. Also be sure to describe the details of the system that ATutor is being developed or tested on, such as the operating system, web server and version, PHP version, etc. Browse the <a href="http://www.atutor.ca/development/bugs/">Current Bug Summary</a> for a list of active big fixing.</p>\r
 \r
 <a href="#top" class="top">top</a>\r
 <h2><a name="creating-bundles"></a>10. Creating Bundles</h2>\r