[Openfirst-cvscommit] www/htdocs/doc/tut/howto atmosphere.php,NONE,1.1 foreword.php,NONE,1.1 glossar
Brought to you by:
xtimg
Update of /cvsroot/openfirst/www/htdocs/doc/tut/howto In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv29440 Added Files: atmosphere.php foreword.php glossary.php history.php index.php information.php preface.php roles.php technology.php Log Message: Add a general HOWTO geared towards new contributors which introduces them to the openFIRST project and tells them everything they know to get started. (not complete yet) --- NEW FILE: history.php --- <h1>The History</h1> <ul> <li><a href="#generaloverview">General Overview</a></li> </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> <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> --- NEW FILE: technology.php --- <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> --- NEW FILE: atmosphere.php --- <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> --- NEW FILE: index.php --- <h1><img src="/image/news_subscribe.png" alt="" title=""> openFIRST Contributor's HOWTO</h1> <p>Timothy D. Ginn <ti...@op...></p> <p>This version is a Working Draft</p> <p>Copyright © 2005 Timothy D. Ginn, the openFIRT Project</p> <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.</p> <p>Thank you greatly to the many people who have contributed to openFIRST in the past, and the present, and to those who will in the future. Parts of this text are taken directly, or adapted from documentation that has been contributed to the openFIRST project.</p> <h2>Table of Contents</h2> <ol> <li><a href="foreword.php">Foreword</a> <ul> <li><a href="foreword.php">...</a></li> </ul></li> <li><a href="preface.php">Preface</a> <ul> <li><a href="preface.php#prerequisites">Prerequisites</a></li> <li><a href="preface.php#approach">Approach</a></li> <li><a href="preface.php#summaryoftopics">Summary of Topics</a></li> <li><a href="preface.php#conventionsused">Conventions Used</a></li> </ul> </li> <li><a href="information.php">Information and Resources</a> <ul> <li><a href="information.php#generalinformation">General Information</a></li> <li><a href="information.php#urls">URLs</a></li> <li><a href="information.php#mailinglists">Mailing lists</a></li> </ul> </li> <li><a href="history.php">The History</a> <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> <p><small>The layout and format of this HOWTO are inspired by and loosely based on that of the <a href="http://developer.kde.org/documentation/tutorials/howto/index.html">KDE Developer's HOWTO</a> and the <a href="http://us4.samba.org/samba/docs/man/Samba-Guide/">Samba-3 by Example Guide</a>.</small></p> --- NEW FILE: foreword.php --- <h1>Foreword</h1> <h2>...</h2> <p><center><a href="index.php">Previous</a> | <a href="index.php">Table of Contents</a> | <a href="preface.php">Next</a></center></p> --- NEW FILE: preface.php --- <h1>Preface</h1> <ul> <li><a href="#prerequisites">Prerequisites</a></li> <li><a href="#approach">Approach</a></li> <li><a href="#summaryoftopics">Summary of Topics</a></li> <li><a href="#conventionsused">Conventions Used</a></li> </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 section 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> <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> --- NEW FILE: information.php --- <h1>Information and Resources</h1> <ul> <li><a href="#generalinformation">General Information</a></li> <li><a href="#urls">URLs</a></li> <li><a href="#mailinglists">Mailing lists</a></li> </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 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> <li>All: <a href="http://www.sourceforge.net/projects/openfirst/">http://www.sourceforge.net/projects/openfirst/</a> - The openFIRST Source Forge Project Page</li> <li>All: <a href="http://www.chiefdelphi.com/forums/forumdisplay.php?f=108">http://www.chiefdelphi.com/forums/forumdisplay.php?f=108</a> - The openFIRST Forum on Chief Delphi</a> <li>Adminstrator, Developer, Documentation Writer, Patch Writer:<a href="http://bugzilla.openfirst.org/">http://bugzilla.openfirst.org/</a> - The openFIRST Bugzilla Page</li> <li>Adminstrator, Developer:<a href="http://update.openfirst.org/">http://update.openfirst.org/</a> - The openFIRST Update Server</li> <li> </ul> <h2><a href="mailinglists">Mailing lists</a></h2> <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> <li>Administrator, Developer, Webmaster: openfirst-webdev</li> <li>Administrator, Developer, Webmaster, Patch Writer, Documentation Writer: openfirst-cvscommit - Receives notifications whenever a commit is made to the openFIRST CVS repository, and is also informed about many Bugzilla bugs. The mailing list is also used by contributors who are working with some code to discuss specific issues with a particular change made in CVS.</li> </ul> <p><center><a href="preface.php">Previous</a> | <a href="index.php">Table of Contents</a> | <a href="history.php">Next</a></center></p> --- NEW FILE: roles.php --- <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> --- NEW FILE: glossary.php --- <h1>Glossary</h1> <h2>...</h2> <p><center><a href="technology.php">Previous</a> | <a href="index.php">Table of Contents</a> | <a href="index.php">Next</a></center></p> |