[Openfirst-cvscommit] www/htdocs/doc/tut/howto atmosphere.php,1.2,1.3 glossary.php,1.3,1.4 history.p
Brought to you by:
xtimg
Menu
▾
▴
[Openfirst-cvscommit] www/htdocs/doc/tut/howto atmosphere.php,1.2,1.3 glossary.php,1.3,1.4 history.php,1.2,1.3 information.php,1.5,1.6 preface.php,1.3,1.4 roles.php,1.3,1.4 technology.php,1.6,1.7
|
From: Tim G. <xt...@us...> - 2005-07-02 15:31:19
|
Update of /cvsroot/openfirst/www/htdocs/doc/tut/howto In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv13954 Modified Files: atmosphere.php glossary.php history.php information.php preface.php roles.php technology.php Log Message: Get rid of long standing annoying 'seisure-causing-flicker-style' effect on mouse over of titles. Index: history.php =================================================================== RCS file: /cvsroot/openfirst/www/htdocs/doc/tut/howto/history.php,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** history.php 29 Dec 2004 17:01:37 -0000 1.2 --- history.php 2 Jul 2005 15:31:05 -0000 1.3 *************** *** 4,8 **** </ul> ! <h2><a name="generaloverview">General Overview</a></h2> <h3>Applies to: All</h3> <p>openFIRST is an initiative to help FIRST Robotics web sites prosper by aiding their developers with design and construction of components for their team's web site. To do this, we have developed open-source components using PHP and ASP using the services of SourceForge.net.</p> --- 4,8 ---- </ul> ! <h2><span id="generaloverview">General Overview</span></h2> <h3>Applies to: All</h3> <p>openFIRST is an initiative to help FIRST Robotics web sites prosper by aiding their developers with design and construction of components for their team's web site. To do this, we have developed open-source components using PHP and ASP using the services of SourceForge.net.</p> Index: technology.php =================================================================== RCS file: /cvsroot/openfirst/www/htdocs/doc/tut/howto/technology.php,v retrieving revision 1.6 retrieving revision 1.7 diff -C2 -d -r1.6 -r1.7 *** technology.php 24 May 2005 22:57:48 -0000 1.6 --- technology.php 2 Jul 2005 15:31:06 -0000 1.7 *************** *** 14,18 **** </ul> ! <h2><a name="email">E-mail</a></h2> <h3>Applies to: All</h3> --- 14,18 ---- </ul> ! <h2><span id="email">E-mail</span></h2> <h3>Applies to: All</h3> *************** *** 21,29 **** <p>A series of mailing lists is also maintained. See the <a href="information.php#mailinglists">Mailing lists heading</a> of the <a href="information.php">Information and Resources section</a> for more information about these mailing lists.</p> ! <h2><a name="webbrowser">The web browser</a></h2> <h3>Applies to: All</h3> <p>...</p> ! <h2><a name="html">HTML</a></h2> <h3>Applies to: Administrator, Developer, Patch Writer, Webmaster, Documentation Writer</h3> <p>The openFIRST project tries when possible to produce valid HTML (matching the particular doctype of any given document). In most cases, the standard currently used is HTML 4. Pages should have valid HTML and should be checked with the W3C HTML Validator at <a href="http://validator.w3.org/">http://validator.w3.org/</a> or a similar tool. It is suggested that you be familiar with HTML, and the HTML standard itself available at <a href="http://w3.org/MarkUp/">http://w3.org/MarkUp/</a> rather than just blindly following a validator.</p> --- 21,29 ---- <p>A series of mailing lists is also maintained. See the <a href="information.php#mailinglists">Mailing lists heading</a> of the <a href="information.php">Information and Resources section</a> for more information about these mailing lists.</p> ! <h2><span id="webbrowser">The web browser</span></h2> <h3>Applies to: All</h3> <p>...</p> ! <h2><span id="html">HTML</span></h2> <h3>Applies to: Administrator, Developer, Patch Writer, Webmaster, Documentation Writer</h3> <p>The openFIRST project tries when possible to produce valid HTML (matching the particular doctype of any given document). In most cases, the standard currently used is HTML 4. Pages should have valid HTML and should be checked with the W3C HTML Validator at <a href="http://validator.w3.org/">http://validator.w3.org/</a> or a similar tool. It is suggested that you be familiar with HTML, and the HTML standard itself available at <a href="http://w3.org/MarkUp/">http://w3.org/MarkUp/</a> rather than just blindly following a validator.</p> *************** *** 31,35 **** <p>The openFIRST project site, and the software created by the project should be as accessible as possible. More information about making web pages accessible is available from the Web Accessibility Initiative at <a href="http://w3.org/WAI/">http://w3.org/WAI/</a>. An Accessibility testing tool called Bobby™ is available at <a href="http://bobby.watchfire.com/bobby/html/en/index.jsp">http://bobby.watchfire.com/bobby/html/en/index.jsp</a>.</p> ! <h2><a name="css">CSS</a></h2> <h3>Applies to: Administrator, Developer, Patch Writer, Webmaster</h3> <p>The openFIRST project tries when possible to sue valid CSS when possible. The current version of the Cascading Style Sheets standard that is used is CSS 2. It is recommended that stylesheets and pages be checked using the CSS validator at <a href="http://jigsaw.w3.org/css-validator/">http://jigsaw.w3.org/css-validator/</a> or a similar tool. It is suggested that you use the CSS standard for reference; the standard is available at <a href="http://w3.org/Style/CSS/">http://w3.org/Style/CSS/</a>.</p> --- 31,35 ---- <p>The openFIRST project site, and the software created by the project should be as accessible as possible. More information about making web pages accessible is available from the Web Accessibility Initiative at <a href="http://w3.org/WAI/">http://w3.org/WAI/</a>. An Accessibility testing tool called Bobby™ is available at <a href="http://bobby.watchfire.com/bobby/html/en/index.jsp">http://bobby.watchfire.com/bobby/html/en/index.jsp</a>.</p> ! <h2><span id="css">CSS</span></h2> <h3>Applies to: Administrator, Developer, Patch Writer, Webmaster</h3> <p>The openFIRST project tries when possible to sue valid CSS when possible. The current version of the Cascading Style Sheets standard that is used is CSS 2. It is recommended that stylesheets and pages be checked using the CSS validator at <a href="http://jigsaw.w3.org/css-validator/">http://jigsaw.w3.org/css-validator/</a> or a similar tool. It is suggested that you use the CSS standard for reference; the standard is available at <a href="http://w3.org/Style/CSS/">http://w3.org/Style/CSS/</a>.</p> *************** *** 37,41 **** <p>Where possible, CSS should be used to make web pages more accessible. More information about making web pages accessible is available from the Web Accessibility Initiative at <a href="http://w3.org/WAI/">http://w3.org/WAI/</a>. An Accessibility testing tool called Bobby™ is available at <a href="http://bobby.watchfire.com/bobby/html/en/index.jsp">http://bobby.watchfire.com/bobby/html/en/index.jsp</a>.</p> ! <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> --- 37,41 ---- <p>Where possible, CSS should be used to make web pages more accessible. More information about making web pages accessible is available from the Web Accessibility Initiative at <a href="http://w3.org/WAI/">http://w3.org/WAI/</a>. An Accessibility testing tool called Bobby™ is available at <a href="http://bobby.watchfire.com/bobby/html/en/index.jsp">http://bobby.watchfire.com/bobby/html/en/index.jsp</a>.</p> ! <h2><span id="bugzilla">Bugzilla</span></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> *************** *** 43,47 **** <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. Upgrades to Bugzilla may require remaking these templates in order for the Bugzilla site to function as expected.</p> ! <h2><a name="updatesystem">openFIRST Update System</a></h2> <h3>Applies to: Administrator, Developer, Patch Writer, Webmaster</h3> --- 43,47 ---- <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. Upgrades to Bugzilla may require remaking these templates in order for the Bugzilla site to function as expected.</p> ! <h2><span id="updatesystem">openFIRST Update System</span></h2> <h3>Applies to: Administrator, Developer, Patch Writer, Webmaster</h3> *************** *** 50,54 **** <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>. A suitable SSH client for Windows is PuTTY, and is available at <a href="http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html">http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html</a>; many other operating systems already include an SSH client, on UNIX or Linux consult <tt>man ssh</tt> for more information. To login, you should use your SourceForge.net username and passsword. It is recommended, for the sake of convenience, that upon logging into the system for the first time, you perform these command:</p> --- 50,54 ---- <p>The openFIRST Update System resides in the <b>update</b> module of the openFIRST CVS repository.</p> ! <h2><span id="shellaccess">Shell Access</span></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>. A suitable SSH client for Windows is PuTTY, and is available at <a href="http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html">http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html</a>; many other operating systems already include an SSH client, on UNIX or Linux consult <tt>man ssh</tt> for more information. To login, you should use your SourceForge.net username and passsword. It is recommended, for the sake of convenience, that upon logging into the system for the first time, you perform these command:</p> *************** *** 66,82 **** <p>...</p> ! <h2><a name="php">PHP</a></h2> <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> <p>...</p> ! <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> --- 66,82 ---- <p>...</p> ! <h2><span id="php">PHP</span></h2> <h3>Applies to: Administrator, Developer, Patch Writer, Release Technician, Webmaster</h3> <p>...</p> ! <h2><span id="asp">ASP</span></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><span id="database">MySQL/Database Software</span></h2> <h3>Applies to: Administrator, Developer, Webmaster</h3> <p>...</p> ! <h2><span id="cvs">CVS</span></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> *************** *** 92,101 **** <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> ! <h2><a name="profiles">Volunteer Profiles</a></h2> <h3>Applies to: All</h3> <p>Those wishing to create a <a href="http://www.openfirst.org/developers/">volunteer profile</a> (previously called developer profile) must check out the www module from CVS and add their profile to the www/htdocs/developer directory then edit index.php of that directory in order to have their profile listed. Alternatively, contact a developer/administrator to have them do this on your behalf. Information about the "Hackergotchi" section of the Volunteer Profiles follows.</p> ! <h2><a name="hackergotchi">Hackergotchi</a></h2> <h3>Applies to: All</h3> <p>Those wishing to create a "Hackergotchi" character may do so. The dimensions recommended are 80 pixels by 80 pixels. To have the Hackergotchi used for news postings, etc. on the main site, using CVS add it to the www/htdocs/image/hackergotchi directory. The Hackergotchi image should be named using your SourceForge.net username and should be of type PNG, JPEG or GIF; the filename must be all lowercase letters. A tutorial on how to create Hackergotchi images is available at <a href="http://www.livejournal.com/users/wouterverhelst/21322.html">http://www.livejournal.com/users/wouterverhelst/21322.html</a>.</p> --- 92,101 ---- <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> ! <h2><span id="profiles">Volunteer Profiles</span></h2> <h3>Applies to: All</h3> <p>Those wishing to create a <a href="http://www.openfirst.org/developers/">volunteer profile</a> (previously called developer profile) must check out the www module from CVS and add their profile to the www/htdocs/developer directory then edit index.php of that directory in order to have their profile listed. Alternatively, contact a developer/administrator to have them do this on your behalf. Information about the "Hackergotchi" section of the Volunteer Profiles follows.</p> ! <h2><span id="hackergotchi">Hackergotchi</span></h2> <h3>Applies to: All</h3> <p>Those wishing to create a "Hackergotchi" character may do so. The dimensions recommended are 80 pixels by 80 pixels. To have the Hackergotchi used for news postings, etc. on the main site, using CVS add it to the www/htdocs/image/hackergotchi directory. The Hackergotchi image should be named using your SourceForge.net username and should be of type PNG, JPEG or GIF; the filename must be all lowercase letters. A tutorial on how to create Hackergotchi images is available at <a href="http://www.livejournal.com/users/wouterverhelst/21322.html">http://www.livejournal.com/users/wouterverhelst/21322.html</a>.</p> Index: atmosphere.php =================================================================== RCS file: /cvsroot/openfirst/www/htdocs/doc/tut/howto/atmosphere.php,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** atmosphere.php 29 Dec 2004 17:01:37 -0000 1.2 --- atmosphere.php 2 Jul 2005 15:31:05 -0000 1.3 *************** *** 6,10 **** </ul> ! <h2><a name="thepeople">The people</a></h2> <h3>Applies to: All</h3> --- 6,10 ---- </ul> ! <h2><span id="thepeople">The people</span></h2> <h3>Applies to: All</h3> *************** *** 13,22 **** <p>It's worth noting that all developers are students (and not University/College mentors) on FIRST Robotics, or FIRST Lego League teams; this is one of the fundamental ideals within openFIRST-- that the project must be student-driven. It's likely that the people you meet doing openFIRST could be the people you go to University or College with in the future, and that they will become your friends. They can also be the people you decide to join or form future projects/companies with. openFIRST isn't an end in itself, it's a starting point. The web portal itself is a starting point for a website and a community; and the relationships with the other contributors can be a starting point for future endeavours.</p> ! <h2><a name="theenvironment">The environment</a></h2> <h3>Applies to: All</h3> <p>openFIRST has little to no unified physical presence; this can be tough, but it also has advantages. Most contributions are made Online, through the Internet. It is possible to spread the word of openFIRST through teaching sessions, and workshops; doing so can provide a personal connection to the project. You can choose where you want to work on the project, and the amount of work you do. The environment is generally pretty calm and laid back (except around release times). People tend to be grateful for your contributions and we <b>do</b> notice the behind the scenes work.</p> ! <h2><a name="thelearning">The learning</a></h2> <h3>Applies to: All</h3> --- 13,22 ---- <p>It's worth noting that all developers are students (and not University/College mentors) on FIRST Robotics, or FIRST Lego League teams; this is one of the fundamental ideals within openFIRST-- that the project must be student-driven. It's likely that the people you meet doing openFIRST could be the people you go to University or College with in the future, and that they will become your friends. They can also be the people you decide to join or form future projects/companies with. openFIRST isn't an end in itself, it's a starting point. The web portal itself is a starting point for a website and a community; and the relationships with the other contributors can be a starting point for future endeavours.</p> ! <h2><span id="theenvironment">The environment</span></h2> <h3>Applies to: All</h3> <p>openFIRST has little to no unified physical presence; this can be tough, but it also has advantages. Most contributions are made Online, through the Internet. It is possible to spread the word of openFIRST through teaching sessions, and workshops; doing so can provide a personal connection to the project. You can choose where you want to work on the project, and the amount of work you do. The environment is generally pretty calm and laid back (except around release times). People tend to be grateful for your contributions and we <b>do</b> notice the behind the scenes work.</p> ! <h2><span id="thelearning">The learning</span></h2> <h3>Applies to: All</h3> Index: information.php =================================================================== RCS file: /cvsroot/openfirst/www/htdocs/doc/tut/howto/information.php,v retrieving revision 1.5 retrieving revision 1.6 diff -C2 -d -r1.5 -r1.6 *** information.php 2 Jul 2005 15:14:31 -0000 1.5 --- information.php 2 Jul 2005 15:31:05 -0000 1.6 *************** *** 6,15 **** </ul> ! <h2><a name="generalinformation">General Information</a></h2> <h3>Applies to: All</h3> <p>The openFIRST Portal System is an integrated set of modules which may be used together to create or enhance a web site. It is directed towards teams participating in the FIRST competition. It is developed by a number of students from FIRST Robotics competition teams.</p> ! <h2><a name="urls">URLs</a></h2> <h3>Applies to: All</h3> <p>The openFIRST Project has several official and unofficial URLs. The list, including who they are relevant to, follows:</p> --- 6,15 ---- </ul> ! <h2><span id="generalinformation">General Information</span></h2> <h3>Applies to: All</h3> <p>The openFIRST Portal System is an integrated set of modules which may be used together to create or enhance a web site. It is directed towards teams participating in the FIRST competition. It is developed by a number of students from FIRST Robotics competition teams.</p> ! <h2><span id="urls">URLs</span></h2> <h3>Applies to: All</h3> <p>The openFIRST Project has several official and unofficial URLs. The list, including who they are relevant to, follows:</p> *************** *** 23,27 **** </ul> ! <h2><a name="mailinglists">Mailing lists</a></h2> <h3>Applies to: All</h3> --- 23,27 ---- </ul> ! <h2><span id="mailinglists">Mailing lists</span></h2> <h3>Applies to: All</h3> Index: preface.php =================================================================== RCS file: /cvsroot/openfirst/www/htdocs/doc/tut/howto/preface.php,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** preface.php 30 Dec 2004 01:53:12 -0000 1.3 --- preface.php 2 Jul 2005 15:31:05 -0000 1.4 *************** *** 8,17 **** </ul> ! <h2><a name="prerequisites">Prerequisites</a></h2> <h3>Applies to: All</h3> <p>To contribute to the openFIRST project, you require at least a basic knowledge in one or more of the following subject areas: English, e-mail, a web browser, HTML, CSS, Bugzilla, PHP, MySQL (and/or other database software), CVS. Aside from that, you should be able to work independently and as part of a team with whom you will have little or no physical contact. Communications skills are very important, and are arguably more important than raw coding ability. In general, the more technically adept you are, the more options are available for you to choose how you'd like to contribute. However, if you're not all that technically adept it may be reassuring to know that it is certainly possible to make a valuable, lasting contribution to openFIRST without writing a single line of code. It is certainly possible to work in complete isolation from the rest of the openFIRST team, and only submit patches to the source code, or documentation, or do publicity work; but, I wouldn't recommend it.</p> ! <h2><a name="approach">Approach</a></h2> <h3>Applies to: All</h3> <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> --- 8,17 ---- </ul> ! <h2><span id="prerequisites">Prerequisites</span></h2> <h3>Applies to: All</h3> <p>To contribute to the openFIRST project, you require at least a basic knowledge in one or more of the following subject areas: English, e-mail, a web browser, HTML, CSS, Bugzilla, PHP, MySQL (and/or other database software), CVS. Aside from that, you should be able to work independently and as part of a team with whom you will have little or no physical contact. Communications skills are very important, and are arguably more important than raw coding ability. In general, the more technically adept you are, the more options are available for you to choose how you'd like to contribute. However, if you're not all that technically adept it may be reassuring to know that it is certainly possible to make a valuable, lasting contribution to openFIRST without writing a single line of code. It is certainly possible to work in complete isolation from the rest of the openFIRST team, and only submit patches to the source code, or documentation, or do publicity work; but, I wouldn't recommend it.</p> ! <h2><span id="approach">Approach</span></h2> <h3>Applies to: All</h3> <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> *************** *** 19,28 **** <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> --- 19,28 ---- <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><span id="summaryoftopics">Summary of Topics</span></h2> <h3>Applies to: All</h3> <p>...</p> ! <h2><span id="conventionsused">Conventions Used</span></h2> <h3>Applies to: All</h3> Index: roles.php =================================================================== RCS file: /cvsroot/openfirst/www/htdocs/doc/tut/howto/roles.php,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** roles.php 5 Jan 2005 19:13:59 -0000 1.3 --- roles.php 2 Jul 2005 15:31:05 -0000 1.4 *************** *** 11,15 **** </ul> ! <h2><a name="outline">Brief Outline of the Roles</a></h2> <h3>Applies to: All</h3> --- 11,15 ---- </ul> ! <h2><span id="outline">Brief Outline of the Roles</span></h2> <h3>Applies to: All</h3> *************** *** 30,34 **** <p><b>Webmaster</b> - Webmaster positions are open to anyone who meets the requirements of the position. A person in the webmaster position is responsible for maintaining and updating the <a href="http://www.openfirst.org/">openfirst.org</a> project site and/or other sites operated by the openFIRST project.</p> ! <h2><a name="administrator">Administrator</a></h2> <h3>Applies to: Administrator</h3> <p>Please read the Administrator section of the Brief Outline above before reading this section.</p> --- 30,34 ---- <p><b>Webmaster</b> - Webmaster positions are open to anyone who meets the requirements of the position. A person in the webmaster position is responsible for maintaining and updating the <a href="http://www.openfirst.org/">openfirst.org</a> project site and/or other sites operated by the openFIRST project.</p> ! <h2><span id="administrator">Administrator</span></h2> <h3>Applies to: Administrator</h3> <p>Please read the Administrator section of the Brief Outline above before reading this section.</p> *************** *** 38,42 **** <p>Please also read the parts of the <a href="technology.php">Technology Section</a> relevant to the Administrator role.</p> ! <h2><a name="developer">Developer (open to students only)</a></h2> <h3>Applies to: Developer</h3> <p>Please read the Developer section of the Brief Outline above before reading this section.</p> --- 38,42 ---- <p>Please also read the parts of the <a href="technology.php">Technology Section</a> relevant to the Administrator role.</p> ! <h2><span id="developer">Developer (open to students only)</span></h2> <h3>Applies to: Developer</h3> <p>Please read the Developer section of the Brief Outline above before reading this section.</p> *************** *** 46,50 **** <p>Please also read the parts of the <a href="technology.php">Technology Section</a> relevant to the Developer role.</p> ! <h2><a name="documentationwriter">Documentation Writer</a></h2> <h3>Applies to: Documentation Writer</h3> <p>Please read the Documentation Writer section of the Brief Outline above before reading this section.</p> --- 46,50 ---- <p>Please also read the parts of the <a href="technology.php">Technology Section</a> relevant to the Developer role.</p> ! <h2><span id="documentationwriter">Documentation Writer</span></h2> <h3>Applies to: Documentation Writer</h3> <p>Please read the Documentation Writer section of the Brief Outline above before reading this section.</p> *************** *** 56,60 **** <p>Please also read the parts of the <a href="technology.php">Technology Section</a> relevant to the Documentation Writer role.</p> ! <h2><a name="patchwriter">Patch Writer (open to students only)</a></h2> <h3>Applies to: Patch Writer</h3> <p>Please read the Patch Writer section of the Brief Outline above before reading this section.</p> --- 56,60 ---- <p>Please also read the parts of the <a href="technology.php">Technology Section</a> relevant to the Documentation Writer role.</p> ! <h2><span id="patchwriter">Patch Writer (open to students only)</span></h2> <h3>Applies to: Patch Writer</h3> <p>Please read the Patch Writer section of the Brief Outline above before reading this section.</p> *************** *** 64,68 **** <p>Please also read the parts of the <a href="technology.php">Technology Section</a> relevant to the Patch Writer role.</p> ! <h2><a name="publicity">Publicity</a></h2> <h3>Applies to: Publicity</h3> <p>Please read the Publicity section of the Brief Outline above before reading this section.</p> --- 64,68 ---- <p>Please also read the parts of the <a href="technology.php">Technology Section</a> relevant to the Patch Writer role.</p> ! <h2><span id="publicity">Publicity</span></h2> <h3>Applies to: Publicity</h3> <p>Please read the Publicity section of the Brief Outline above before reading this section.</p> *************** *** 72,76 **** <p>You may also wish to read the parts of the <a href="technology.php">Technology Section</a> relevant to the Publicity role. You may or may not have to actually use any of these technologies depending on the method you choose to pursue for publicising the openFIRST project; but, it having a working knowledge of them may be useful. Alternatively, you may wish to use the technology section only as a reference.</p> ! <h2><a name="releasetechnician">Release Technician</a></h2> <h3>Applies to: Release Technician</h3> <p>Please read the Release Technician section of the Brief Outline above before reading this section.</p> --- 72,76 ---- <p>You may also wish to read the parts of the <a href="technology.php">Technology Section</a> relevant to the Publicity role. You may or may not have to actually use any of these technologies depending on the method you choose to pursue for publicising the openFIRST project; but, it having a working knowledge of them may be useful. Alternatively, you may wish to use the technology section only as a reference.</p> ! <h2><span id="releasetechnician">Release Technician</span></h2> <h3>Applies to: Release Technician</h3> <p>Please read the Release Technician section of the Brief Outline above before reading this section.</p> *************** *** 80,84 **** <p>Please also read the parts of the <a href="technology.php">Technology Section</a> relevant to the Release Technician role.</p> ! <h2><a name="webmaster">Webmaster</a></h2> <h3>Applies to: Webmaster</h3> <p>Please read the Webmaster section of the Brief Outline above before reading this section.</p> --- 80,84 ---- <p>Please also read the parts of the <a href="technology.php">Technology Section</a> relevant to the Release Technician role.</p> ! <h2><span id="webmaster">Webmaster</span></h2> <h3>Applies to: Webmaster</h3> <p>Please read the Webmaster section of the Brief Outline above before reading this section.</p> Index: glossary.php =================================================================== RCS file: /cvsroot/openfirst/www/htdocs/doc/tut/howto/glossary.php,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** glossary.php 30 Dec 2004 01:53:12 -0000 1.3 --- glossary.php 2 Jul 2005 15:31:05 -0000 1.4 *************** *** 3,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 --- 3,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><span id="bz"><b>BZ</b></span> - 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><span id="module"><b>module</b><span> - 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 |
