[Openfirst-cvscommit] www/htdocs/doc/tut/howto atmosphere.php,1.1,1.2 glossary.php,1.1,1.2 history.p
Brought to you by:
xtimg
Menu
▾
▴
[Openfirst-cvscommit] www/htdocs/doc/tut/howto atmosphere.php,1.1,1.2 glossary.php,1.1,1.2 history.php,1.1,1.2 index.php,1.1,1.2 information.php,1.1,1.2 preface.php,1.1,1.2 roles.php,1.1,1.2 technology.php,1.1,1.2
Update of /cvsroot/openfirst/www/htdocs/doc/tut/howto In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv17322 Modified Files: atmosphere.php glossary.php history.php index.php information.php preface.php roles.php technology.php Log Message: Write a few more sections of the documentation, misc. fixes for typos, etc. in a few of the earlier sections Index: history.php =================================================================== RCS file: /cvsroot/openfirst/www/htdocs/doc/tut/howto/history.php,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** history.php 29 Dec 2004 02:20:37 -0000 1.1 --- history.php 29 Dec 2004 17:01:37 -0000 1.2 *************** *** 10,14 **** <p>openFIRST was initially founded by David Di Biase and Tim Ginn in 2003 at the FIRST Canadian Regional, where both their teams competed. During the competition David and Tim discussed a potential project of this mass. The weeks following consisted of constant develop until the beginning of 2004 season, where they released their creation to the world.</p> ! <p>To this day the openFIRST development is striving to expand and create one of the largest most widely used open-source softwares for the FIRST competition's of North America. Their next goal is to expand the openFIRST source code and make it even more advanced and easy-to-use with the help of FIRST student programmers.</p> <p><center><a href="information.php">Previous</a> | <a href="index.php">Table of Contents</a> | <a href="atmosphere.php">Next</a></center></p> \ No newline at end of file --- 10,14 ---- <p>openFIRST was initially founded by David Di Biase and Tim Ginn in 2003 at the FIRST Canadian Regional, where both their teams competed. During the competition David and Tim discussed a potential project of this mass. The weeks following consisted of constant develop until the beginning of 2004 season, where they released their creation to the world.</p> ! <p>To this day the openFIRST development is striving to expand and create one of the largest most widely used open-source software for the FIRST competition's of North America. Their next goal is to expand the openFIRST source code and make it even more advanced and easy-to-use with the help of FIRST student programmers.</p> <p><center><a href="information.php">Previous</a> | <a href="index.php">Table of Contents</a> | <a href="atmosphere.php">Next</a></center></p> \ No newline at end of file Index: technology.php =================================================================== RCS file: /cvsroot/openfirst/www/htdocs/doc/tut/howto/technology.php,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** technology.php 29 Dec 2004 02:20:37 -0000 1.1 --- technology.php 29 Dec 2004 17:01:37 -0000 1.2 *************** *** 1,5 **** <h1>The Technologies</h1> ! <h2>...</h2> ! <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 --- 1,49 ---- <h1>The Technologies</h1> ! <ul> ! <li><a href="#email">E-mail</a></li> ! <li><a href="#webbrowser">The web browser</a></li> ! <li><a href="#html">HTML</a></li> ! <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> + + <p>The openFIRST project maintains the <a href="http://www.openfirst.org/">openfirst.org</a> e-mail addresses (eg. <a href="mailto: ti...@op...">ti...@op...</a>). These addresses are most often set to forward to a contributors personal e-mail account by an administrator. E-mail addresses are assigned as fir...@op.... If you did not get an e-mail address assigned to you when you joined, or would like to change the address that mail is forwarded to, contact an administrator.</p> + + <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>...</p> + + <h2><a name="css">CSS</a></h2> + <h3>Applies to: Administrator, Developer, Patch Writer, Webmaster</h3> + <p>...</p> + + <h2><a name="bugzilla">Bugzilla</a></h2> + <h3>Applies to: Administrator, Developer, Documentation Writer, Patch Writer, Webmaster</h3> + <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="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>...</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: atmosphere.php =================================================================== RCS file: /cvsroot/openfirst/www/htdocs/doc/tut/howto/atmosphere.php,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** atmosphere.php 29 Dec 2004 02:20:37 -0000 1.1 --- atmosphere.php 29 Dec 2004 17:01:37 -0000 1.2 *************** *** 1,5 **** <h1>The Atmosphere</h1> ! <h2>...</h2> <p><center><a href="history.php">Previous</a> | <a href="index.php">Table of Contents</a> | <a href="roles.php">Next</a></center></p> \ No newline at end of file --- 1,27 ---- <h1>The Atmosphere</h1> ! <ul> ! <li><a href="#thepeople">The people</a></li> ! <li><a href="#theenvironment">The environment</a></li> ! <li><a href="#thelearning">The learning</a></li> ! </ul> ! ! <h2><a name="thepeople">The people</a></h2> ! <h3>Applies to: All</h3> ! ! <p>The people you'll meet through working on openFIRST tend to be diligent workers who love what they do. That's not to say everyone's happy all the time, deadlines and release dates can be stressful. Throughout your time contributing to openFIRST, you'll face challenges with the group, conflicts with people, clashes of ideas, and eventually triumph over adversity to make a lasting difference to the project.</p> ! ! <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> + + <p>One of the goals of the openFIRST project is to cause students to learn as much as possible. This includes not only the technical aspects of any given role, but also group dynamics. What people learn from the openFIRST project is as diverse as the people themselves. As a general rule, you get back from the project what you put into it; even if the reward is delayed.</p> + + <p>Take an active role. Contribute. It's worth-while.</p> <p><center><a href="history.php">Previous</a> | <a href="index.php">Table of Contents</a> | <a href="roles.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.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** index.php 29 Dec 2004 02:20:37 -0000 1.1 --- index.php 29 Dec 2004 17:01:37 -0000 1.2 *************** *** 36,71 **** <ul><a href="history.php#generaloverview">General Overview</a></ul> </li> ! <li>The Atmosphere <ul> ! <li>The people</li> ! <li>The environment</li> ! <li>The learning</li> </ul> </li> ! <li>The Roles <ul> ! <li>Brief Outline of the Roles</li> ! <li>Administrator</li> ! <li>Developer</li> ! <li>Documentation Writer</li> ! <li>Patch Writer</li> ! <li>Publicity</li> ! <li>Release Technician</li> ! <li>Webmaster</li> </ul> </li> ! <li>The Technologies <ul> ! <li>E-mail</li> ! <li>The web browser</li> ! <li>HTML</li> ! <li>CSS</li> ! <li>Bugzilla</li> ! <li>PHP</li> ! <li>MySQL/Database Software</li> ! <li>CVS</li> </ul> </li> ! <li>Glossary</li> </ol> --- 36,71 ---- <ul><a href="history.php#generaloverview">General Overview</a></ul> </li> ! <li><a href="atmosphere.php">The Atmosphere</a> <ul> ! <li><a href="atmosphere.php#thepeople">The people</a></li> ! <li><a href="atmosphere.php#theenvironment">The environment</a></li> ! <li><a href="atmosphere.php#thelearning">The learning</a></li> </ul> </li> ! <li><a href="roles.php">The Roles</a> <ul> ! <li><a href="roles.php#outline">Brief Outline of the Roles</a></li> ! <li><a href="roles.php#administrator">Administrator</a></li> ! <li><a href="roles.php#developer">Developer (open to students only)</a></li> ! <li><a href="roles.php#documentationwriter">Documentation Writer</a></li> ! <li><a href="roles.php#patchwriter">Patch Writer (open to students only)</a></li> ! <li><a href="roles.php#publicity">Publicity</a></li> ! <li><a href="roles.php#releasetechnician">Release Technician</a></li> ! <li><a href="roles.php#webmaster">Webmaster</a></li> </ul> </li> ! <li><a href="technology.php">The Technologies</a> <ul> ! <li><a href="technology.php#email">E-mail</a></li> ! <li><a href="technology.php#webbrowser">The web browser</a></li> ! <li><a href="technology.php#html">HTML</a></li> ! <li><a href="technology.php#css">CSS</a></li> ! <li><a href="technology.php#bugzilla">Bugzilla</a></li> ! <li><a href="technology.php#php">PHP</a></li> ! <li><a href="technology.php#database">MySQL/Database Software</a></li> ! <li><a href="technology.php#cvs">CVS</a></li> </ul> </li> ! <li><a href="glossary.php">Glossary</a></li> </ol> Index: preface.php =================================================================== RCS file: /cvsroot/openfirst/www/htdocs/doc/tut/howto/preface.php,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** preface.php 29 Dec 2004 02:20:37 -0000 1.1 --- preface.php 29 Dec 2004 17:01:37 -0000 1.2 *************** *** 15,19 **** <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 section of this document are clearly marked as to what roles they pertain to.</p> --- 15,19 ---- <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> *************** *** 26,28 **** <p>Each section of this document is marked underneath the section title as to which roles it applies to.</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> \ No newline at end of file --- 26,28 ---- <p>Each section of this document is marked underneath the section title as to which roles it applies to.</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: information.php =================================================================== RCS file: /cvsroot/openfirst/www/htdocs/doc/tut/howto/information.php,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** information.php 29 Dec 2004 02:20:37 -0000 1.1 --- information.php 29 Dec 2004 17:01:37 -0000 1.2 *************** *** 13,17 **** <h2><a href="urls">URLs</a></h2> <h3>Applies to: All</h3> ! <p>The openFIRST Project site has several official and unofficial URLs for the openFIRST project. The list, including who they are relevant to, follows:</p> <ul> <li>All: <a href="http://www.openfirst.org/">http://www.openfirst.org/</a> - The openFIRST Home Page</li> --- 13,17 ---- <h2><a href="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> <ul> <li>All: <a href="http://www.openfirst.org/">http://www.openfirst.org/</a> - The openFIRST Home Page</li> *************** *** 26,30 **** <h3>Applies to: All</h3> ! <p>The openFIRST Project makes use of a few mailing lit. All lists may be subscribed to by sending a blank e-mail to lis...@li.... They, including who they're relevant to, include:</p> <ul> --- 26,30 ---- <h3>Applies to: All</h3> ! <p>The openFIRST Project makes use of a few mailing lists. All lists may be subscribed to by sending a blank e-mail to lis...@li.... They, including who they're relevant to, include:</p> <ul> *************** *** 34,36 **** ! <p><center><a href="preface.php">Previous</a> | <a href="index.php">Table of Contents</a> | <a href="history.php">Next</a></center></p> \ No newline at end of file --- 34,36 ---- ! <p><center><a href="preface.php">Previous</a> | <a href="index.php">Table of Contents</a> | <a href="history.php">Next</a></center></p> Index: roles.php =================================================================== RCS file: /cvsroot/openfirst/www/htdocs/doc/tut/howto/roles.php,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** roles.php 29 Dec 2004 02:20:37 -0000 1.1 --- roles.php 29 Dec 2004 17:01:37 -0000 1.2 *************** *** 1,5 **** <h1>The Roles</h1> ! <h2>...</h2> - <p><center><a href="atmosphere.php">Previous</a> | <a href="index.php">Table of Contents</a> | <a href="technology.php">Next</a></center></p> \ No newline at end of file --- 1,74 ---- <h1>The Roles</h1> ! <ul> ! <li><a href="#outline">Brief Outline of the Roles</a></li> ! <li><a href="#administrator">Administrator</a></li> ! <li><a href="#developer">Developer (open to students only)</a></li> ! <li><a href="#documentationwriter">Documentation Writer</a></li> ! <li><a href="#patchwriter">Patch Writer (open to students only)</a></li> ! <li><a href="#publicity">Publicity</a></li> ! <li><a href="#releasetechnician">Release Technician</a></li> ! <li><a href="#webmaster">Webmaster</a></li> ! </ul> ! ! <h2><a name="outline">Brief Outline of the Roles</a></h2> ! <h3>Applies to: All</h3> ! ! <p>It's important to the project that everyone who's contributing has at least a general idea of what the other contributors are doing. People who are interested in starting to contribute to the project may not be entirely clear on how they can help. The following paragraphs give a brief overview of each position. More detailed information, including information about what people who are considering taking on a position should now, is included below the brief overview paragraphs.</p> ! ! <p><b>Administrator</b> - Administrative positions are open to anyone who meets the requirements of the position. Administrators make sure that the servers which the openFIRST project use remain operational, and add/manage users and permissions for other contributors. An administrator is expected to audit developers' code, and to commit patches to the CVS repository on behalf of patch writers. In general, if a particular role is not being filled, it is expected that an administrator will take over that role on a temporary basis.</p> ! ! <p><b>Developer</b> - Development positions are only open to students who are at the elementary or high school level (and not to University/College/alumni). Developers are the ones who actually write the code for the openFIRST project. A developer produces the modules that are used by teams which use the openFIRST software. A developer is also expected to audit other developers' code, and to commit patches to the CVS repository on behalf of patch writers.</p> ! ! <p><b>Documentation Writer</b> - Documentation writer positions are open to anyone who meets the requirements of the position. Documentation writers create user and contributor manuals, README files, and other similar content. Documentation writers are responsible for proof reading and keeping up to date existing documentation.</p> ! ! <p><b>Patch Writer</b> - Patch writer positions are only open to students who are at the elementary or high school level (and not to University/College/alumni). Patch writers primarily fix bugs found on Bugzilla, but may also introduce new features. Patch writers do not have direct access to CVS, and must pass their patches through a Developer/Administrator before code enters the project repository.</p> ! ! <p><b>Publicity</b> - Publicity positions are open to anyone who meets the requirements of the position. People in a Publicity role are expected to spread the word of openFIRST to those who may be interested. Possible ways of doing this include posting on relevent FIRST Robotics forums, giving workshops/tutorials about using the openFIRST system, and running openFIRST slide shows in the pit area at Regional/National competitions.</p> ! ! <p><b>Release Technician</b> - Release technician positions are open to anyone who meets the requirements of the position. A release technician is responsible for packaging the openFIRST modules for distribution through the Source Forge file release system. Release technicians operate on formal releases only (testing and ensuring that all developers have contributed all features that are expected to be present in a version, before packaging it), nightly builds are automated and do not involve a release technician.</p> ! ! <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> ! ! <p>...</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> ! ! <p>...</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> ! ! <p>...</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> ! ! <p>...</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> ! ! <p>...</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> ! ! <p>...</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> ! ! <p>...</p> <p><center><a href="atmosphere.php">Previous</a> | <a href="index.php">Table of Contents</a> | <a href="technology.php">Next</a></center></p> \ No newline at end of file Index: glossary.php =================================================================== RCS file: /cvsroot/openfirst/www/htdocs/doc/tut/howto/glossary.php,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** glossary.php 29 Dec 2004 02:20:37 -0000 1.1 --- glossary.php 29 Dec 2004 17:01:37 -0000 1.2 *************** *** 1,4 **** <h1>Glossary</h1> ! <h2>...</h2> --- 1,7 ---- <h1>Glossary</h1> ! ! <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> |
