[Openfirst-cvscommit] www/htdocs/doc/tut/howto foreword.php,1.1,1.2 glossary.php,1.2,1.3 index.php,1
Brought to you by:
xtimg
Menu
▾
▴
[Openfirst-cvscommit] www/htdocs/doc/tut/howto foreword.php,1.1,1.2 glossary.php,1.2,1.3 index.php,1.2,1.3 preface.php,1.2,1.3 technology.php,1.3,1.4
|
From: Tim G. <xt...@us...> - 2004-12-30 01:53:26
|
Update of /cvsroot/openfirst/www/htdocs/doc/tut/howto In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv23065 Modified Files: foreword.php glossary.php index.php preface.php technology.php Log Message: Latest batch of updates, including answers to some of the questions asked by Larry and Anthony on their first day as project members, and information that may be useful gathered from conversation logs of discussions I've had with Jamie since he joined. Index: technology.php =================================================================== RCS file: /cvsroot/openfirst/www/htdocs/doc/tut/howto/technology.php,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** technology.php 29 Dec 2004 20:41:25 -0000 1.3 --- technology.php 30 Dec 2004 01:53:12 -0000 1.4 *************** *** 6,14 **** <li><a href="#css">CSS</a></li> <li><a href="#bugzilla">Bugzilla</a></li> <li><a href="#php">PHP</a></li> <li><a href="#database">MySQL/Database Software</a></li> <li><a href="#cvs">CVS</a></li> </ul> ! <h2><a name="email">E-mail</a></h2> <h3>Applies to: All</h3> --- 6,17 ---- <li><a href="#css">CSS</a></li> <li><a href="#bugzilla">Bugzilla</a></li> + <li><a href="#updatesystem">openFIRST Update System</a></li> + <li><a href="#shellaccess">Shell Access</a></li> <li><a href="#php">PHP</a></li> + <li><a href="#asp">ASP</a></li> <li><a href="#database">MySQL/Database Software</a></li> <li><a href="#cvs">CVS</a></li> </ul> ! <h2><a name="email">E-mail</a></h2> <h3>Applies to: All</h3> *************** *** 36,39 **** --- 39,59 ---- <h2><a name="bugzilla">Bugzilla</a></h2> <h3>Applies to: Administrator, Developer, Documentation Writer, Patch Writer, Webmaster</h3> + <p>Bugzilla (<a href="http://bugzilla.openfirst.org/">http://bugzilla.openfirst.org/</a>) keeps track of bug reports and feature requests for both source code and documentation. Issues of an administrative nature may also be posted on Bugzilla. As a contributor to the openFIRST project you should register for a Bugzilla account using your @openfirst.org e-mail address. Only e-mail addresses that are @openfirst.org show up in the bug crusher statistics on the openfirst.org site and installations of the openFIRST System. To be credited as having crushed a bug, the bug must be finished (eg marked CLOSED, FIXED, etc.) but not DUPLICATE and the bug must be assigned to you at the time it is closed.</p> + + <p>Automated bug reports are filed by openFIRST installations and are clearly marked as such. You, as one who browses Bugzilla should change the subject of Automated bug reports to better reflect their content and/or mark them as DUPLICATE if applicable. Automated bug reports are reported through <a href="http://bugzilla.openfirst.org/openfirst/">http://bugzilla.openfirst.org/openfirst/</a> and bug crusher statistics are available at <a href="http://bugzilla.openfirst.org/openfirst/bugcrushers.php">http://bugzilla.openfirst.org/openfirst/bugcrushers.php</a>. The style sheet and design information for the Bugzilla site is present within the CVS repository in the <b>htdocs/bugzilla</b> directory of the <b>www</b> module.</p> + + <h2><a name="updatesystem">openFIRST Update System</a></h2> + <h3>Applies to: Administrator, Developer, Patch Writer, Webmaster</h3> + + <p>The openFIRST Update System is currently under development at <a href="http://update.openfirst.org/test/">http://update.openfirst.org/test/</a>. The goal of the system is to create a simple interface for end users to remotely install and manage any number of openFIRST installations. The system will be able to automate installation of updates and security patches, and communicates directly with the end-user's web server, preventing users on slow connections from having to undergo the lengthy download process to get the full openFIRST system. Third parties will be able to submit packages to be managed by the openFIRST Update System, and can mark security updates, new versions, etc. which will notify end users who have set their preferences as such.</p> + + <p>The openFIRST Update System resides in the <b>update</b> module of the openFIRST CVS repository.</p> + + <h2><a name="shellaccess">Shell Access</a></h2> + <h3>Applies to: Administrator, Developer, Webmaster</h3> + <p>All developers, webmasters, and administrators are able to access the SourceForge.net Project Shell Server via SSH at <b>shell.sourceforge.net</b>.</p> + + <p>Administrators and webmasters of other openFIRST sites may be able to access them via SSH using a different login name and password. If you require shell access to one of these other sites, or to the SF.net Project Shell Server, contact an administrator.</p> + <p>...</p> *************** *** 41,45 **** <h3>Applies to: Administrator, Developer, Patch Writer, Release Technician, Webmaster</h3> <p>...</p> ! <h2><a name="database">MySQL/Database Software</a></h2> <h3>Applies to: Administrator, Developer, Webmaster</h3> --- 61,69 ---- <h3>Applies to: Administrator, Developer, Patch Writer, Release Technician, Webmaster</h3> <p>...</p> ! ! <h2><a name="asp">ASP</a></h2> ! <h3>Applies to: Administrator, Developer, Patch Writer, Release Technician, Webmaster</h3> ! <p>Very little of the project is written in ASP at the moment, and the ASP versions have been unmaintained for quite some time now. The original creator of the ASP modules graduated before the project had any real plan for replacing graduated developers. Ideally we'd find someone who could take them over, but the focus is on the PHP versions of modules. If you happen to be interested in bringing the ASP versions up to date (with features that parallel the PHP versions of modules) contact an Administrator.</p> ! <h2><a name="database">MySQL/Database Software</a></h2> <h3>Applies to: Administrator, Developer, Webmaster</h3> *************** *** 48,55 **** <h2><a name="cvs">CVS</a></h2> <h3>Applies to: Administrator, Developer, Documentation Writer, Release Technician, Webmaster</h3> ! <p>CVS is used by the openFIRST project for version control. It allows multiple contributors to work on the project at one time without interfering with one another's work. CVS can merge different changes to a file in an intelligent way; but it's merging attempts should be verfied manually just to be certain.</p> ! <p>One possible route for accessing the CVS repository is using Smart CVS (<a href="http://www.smartcvs.com/">http://www.smartcvs.com/</a>). Documentation about how to configure Smart CVS 3 (the newer version) is available at <a href="http://www.openfirst.org/cvs/smartcvs3/">http://www.openfirst.org/cvs/smartcvs3/</a> and documentation for Smart CVS 2 (an older version) is available at <a href="http://www.openfirst.org/cvs/smartcvs/">http://www.openfirst.org/cvs/smartcvs/</a>. It is recommended that contributors who will be using CVS, especially Administrators, also skim/read the SourceForge.net Project Documentation pertaining to CVS available at: <a href="http://www.sourceforge.net/docman/?group_id=1">http://www.sourceforge.net/docman/?group_id=1</a>.</p> ! <p><center><a href="roles.php">Previous</a> | <a href="index.php">Table of Contents</a> | <a href="glossary.php">Next</a></center></p> \ No newline at end of file --- 72,86 ---- <h2><a name="cvs">CVS</a></h2> <h3>Applies to: Administrator, Developer, Documentation Writer, Release Technician, Webmaster</h3> ! <p>CVS is used by the openFIRST project for version control. It allows multiple contributors to work on the project at one time without interfering with one another's work. CVS can merge different changes to a file in an intelligent way; but it's merging attempts should be verfied manually just to be certain. To login to CVS, use your SourceForge.net username and password.</p> ! <p>One possible route for accessing the CVS repository is using Smart CVS (<a href="http://www.smartcvs.com/">http://www.smartcvs.com/</a>). Documentation about how to configure Smart CVS 3 (the newer version) is available at <a href="http://www.openfirst.org/cvs/smartcvs3/">http://www.openfirst.org/cvs/smartcvs3/</a> and documentation for Smart CVS 2 (an older version) is available at <a href="http://www.openfirst.org/cvs/smartcvs/">http://www.openfirst.org/cvs/smartcvs/</a>. There are other CVS clients which will work, and may be more suited to your personal preference. It is recommended that contributors who will be using CVS, especially Administrators, also skim/read the SourceForge.net Project Documentation pertaining to CVS available at: <a href="http://www.sourceforge.net/docman/?group_id=1">http://www.sourceforge.net/docman/?group_id=1</a> (the documentation includes a list of several alternatives to SmartCVS at <a href="http://sourceforge.net/docman/display_doc.php?docid=14033&group_id=1#howtoaccess">http://sourceforge.net/docman/display_doc.php?docid=14033&group_id=1#howtoaccess</a>). Read-only access to the CVS repository is available through a web browser using viewcvs at <a href="http://cvs.sourceforge.net/viewcvs.py/openfirst/">http://cvs.sourceforge.net/viewcvs.py/openfirst/</a>; but at the current time, viewcvs does not keep in perfect sync with the cvs repository as developers see it; it lags behind a bit.</p> ! ! <p>Some general rules for CVS include:</p> ! <ul> ! <li>Always run a diff before making a commit, to make sure you're committing only the changes you think you are</li> ! <li>Always update before making a commit</li> ! </ul> ! ! <p>Important Note: the <b>config</b> module is <b>depreciated</b>. Please use the base module instead. That is to say, <b>don't use the config module</b>. The idea behind the move from <b>config</b> to <b>base</b> is that using <b>base</b> a common index page could be created, and resources such as images that are used throughout the site could be in one place (Release technicians rename base to openfirst when distributing the base package. On the webserver, modules are installed within the root of the base module [eg openfirst/guestbook or base/guestbook]. This is why some modules may <b>appear</b> to use the config module, when in fact they do not). The reason that the <b>config</b> module is still in CVS, is because very old versions of openFIRST used to use it. SourceForge doesn't allow the removal of modules; and even if it did, config is part of the history of the project. <b>config</b> remains in the CVS repository on the off chance that someone running a very old version may want to upgrade/patch their install, in which case the <b>config</b> module provides all of the patches up until the point that it became unsupported (which was after the last official release that made use of the module).</p> <p><center><a href="roles.php">Previous</a> | <a href="index.php">Table of Contents</a> | <a href="glossary.php">Next</a></center></p> \ No newline at end of file Index: index.php =================================================================== RCS file: /cvsroot/openfirst/www/htdocs/doc/tut/howto/index.php,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** index.php 29 Dec 2004 17:01:37 -0000 1.2 --- index.php 30 Dec 2004 01:53:12 -0000 1.3 *************** *** 62,66 **** --- 62,68 ---- <li><a href="technology.php#css">CSS</a></li> <li><a href="technology.php#bugzilla">Bugzilla</a></li> + <li><a href="technology.php#updatesystem">openFIRST Update System</a></li> <li><a href="technology.php#php">PHP</a></li> + <li><a href="technology.php#asp">ASP</a></li> <li><a href="technology.php#database">MySQL/Database Software</a></li> <li><a href="technology.php#cvs">CVS</a></li> Index: foreword.php =================================================================== RCS file: /cvsroot/openfirst/www/htdocs/doc/tut/howto/foreword.php,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** foreword.php 29 Dec 2004 02:20:37 -0000 1.1 --- foreword.php 30 Dec 2004 01:53:12 -0000 1.2 *************** *** 1,3 **** --- 1,7 ---- <h1>Foreword</h1> + /* + Ideally the Foreword should mention at least some of the teams that are using the software. + */ + <h2>...</h2> Index: preface.php =================================================================== RCS file: /cvsroot/openfirst/www/htdocs/doc/tut/howto/preface.php,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** preface.php 29 Dec 2004 17:01:37 -0000 1.2 --- preface.php 30 Dec 2004 01:53:12 -0000 1.3 *************** *** 7,11 **** <li><a href="#conventionsused">Conventions Used</a></li> </ul> ! <h2><a name="prerequisites">Prerequisites</a></h2> <h3>Applies to: All</h3> --- 7,11 ---- <li><a href="#conventionsused">Conventions Used</a></li> </ul> ! <h2><a name="prerequisites">Prerequisites</a></h2> <h3>Applies to: All</h3> *************** *** 17,24 **** <p>For the most part, this document is broken down into two main sections. The first section is general information that is useful background knowledge for all contributors; I would suggest that everyone read this part. The second situation is oriented around specific roles that you may wish to take as a contributor. A brief description of all of the roles is provided at the beginning of this section, and I would suggest that you read the information for all roles that sound appealing to you. In general, the brief descriptions provide as much information about the role as someone not considering taking it on would need. All sections of this document are clearly marked as to what roles they pertain to.</p> ! <h2><a name="summaryoftopics">Summary of Topics</a></h2> <h3>Applies to: All</h3> ! <h2><a name="conventionsused">Conventions Used</a></h2> <h3>Applies to: All</h3> --- 17,27 ---- <p>For the most part, this document is broken down into two main sections. The first section is general information that is useful background knowledge for all contributors; I would suggest that everyone read this part. The second situation is oriented around specific roles that you may wish to take as a contributor. A brief description of all of the roles is provided at the beginning of this section, and I would suggest that you read the information for all roles that sound appealing to you. In general, the brief descriptions provide as much information about the role as someone not considering taking it on would need. All sections of this document are clearly marked as to what roles they pertain to.</p> ! <p>In terms of the approach that is taken to the openFIRST project itself, what the project is trying to create is software that is specialized for FIRST teams, with easily-modifyable code that follows standard conventions. The approach we take is to create a completely student-designed and built website. All code that leaves the project targetted to end users (that is, packaged modules) is completely student-created. A potential problem with this, is that there is guaranteed to be a fairly high developer turnover rate, and that no single developer is a student long enough to see the openFIRST project from start to finish. The approach that the project takes to deal with this issue is to have other people work from the foundation that the people who have since graduated built with guidance and mentorship by previous developers. The openFIRST approach isn't to merely package and integrate disparate software from other Open Source or proprietary sources into a connected system, it's to create a new system.</p> ! <h2><a name="summaryoftopics">Summary of Topics</a></h2> <h3>Applies to: All</h3> ! ! <p>...</p> ! <h2><a name="conventionsused">Conventions Used</a></h2> <h3>Applies to: All</h3> *************** *** 26,28 **** --- 29,33 ---- <p>Each section of this document is marked underneath the section title as to which roles it applies to.</p> + <p>...</p> + <p><center><a href="foreword.php">Previous</a> | <a href="index.php">Table of Contents</a> | <a href="information.php">Next</a></center></p> Index: glossary.php =================================================================== RCS file: /cvsroot/openfirst/www/htdocs/doc/tut/howto/glossary.php,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** glossary.php 29 Dec 2004 17:01:37 -0000 1.2 --- glossary.php 30 Dec 2004 01:53:12 -0000 1.3 *************** *** 2,8 **** <p>The glossary is arranged in alphabetical order. Sections and whom they are relevant are not marked, as it is assumed this will be used primarily as a reference when an unfamiliar term is mentioned elsewhere.</p> ! <p><a name="bz"><b>BZ</b></a> - BZ is often used as a short form to refer to the openFIRST project's Bugzilla Site (<a href="http://bugzilla.openfirst.org/">http://bugzilla.openfirst.org</a>).</p> <p><center><a href="technology.php">Previous</a> | <a href="index.php">Table of Contents</a> | <a href="index.php">Next</a></center></p> \ No newline at end of file --- 2,9 ---- <p>The glossary is arranged in alphabetical order. Sections and whom they are relevant are not marked, as it is assumed this will be used primarily as a reference when an unfamiliar term is mentioned elsewhere.</p> ! <p><a name="bz"><b>BZ</b></a> - BZ is often used as a short form to refer to the openFIRST project's Bugzilla Site (<a href="http://bugzilla.openfirst.org/">http://bugzilla.openfirst.org</a>).</p> + <p><a name="module"><b>module</b><a> - when referring to the distributed modules (as in the modules produced by the openFIRST project), a module is a component of a complete site. People can pick and choose which modules to install from a wide selection (eg, a guestbook, a members area, etc.). When referring to CVS, a module is a given component within the project CVS archive. There are modules which are only used internally by the project (for example, there's a module that houses the website, and one that is home to the remote update server software). The internal modules, and some modules that may be in CVS are not necessarily packaged and distributed to external users; however, external users can access them if they're so inclined (but doing so requires the use of a CVS client).</p> <p><center><a href="technology.php">Previous</a> | <a href="index.php">Table of Contents</a> | <a href="index.php">Next</a></center></p> \ No newline at end of file |
