Changes between Version 5 and Version 6 of TracGuide


Ignore:
Timestamp:
16.07.2010 19:25:56 (8 weeks ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracGuide

    v5 v6  
    1 = The ''Project !BattleCube'' User Guide = 
     1= The Trac User and Administration Guide = 
     2[[TracGuideToc]] 
    23 
    3 {{{ 
    4 #!html 
    5 <h1 style="text-align: center; color: blue;">NO PANIC!</h1> 
    6 }}} 
     4The TracGuide is meant to serve as a starting point for all documentation regarding Trac usage and development. The guide is a free document, a collaborative effort, and a part of the [http://trac.edgewall.org Trac Project] itself. 
    75 
    8 This guide will be used to help you using this trac as your coordination and working platform. For developers we offer several features which i want to explain to show how to use them and for what. But at first you need to register at http://cubestats.net/Register/?from=battlecube and talk to Dokujisan and Getty to active your account for developer rights. As regular user you can still make tickets and talk with us on the forum. Our pastebin service is general for free use, even unregistered. If you are a developer you should than edit your profile with http://battlecube.org/developerprofile. 
     6== Table of Contents == 
    97 
    10  * '''Forum''' 
     8Currently available documentation: 
     9 * '''User Guide''' 
     10   * TracWiki — How to use the built-in Wiki. 
     11   * TracTimeline — The timeline provides a historic perspective on a project. 
     12   * TracRss — RSS content syndication in Trac. 
     13   * ''The Version Control Subsystem'' 
     14     * TracBrowser — Browsing source code with Trac. 
     15     * TracChangeset — Viewing changes to source code. 
     16     * TracRevisionLog — Viewing change history. 
     17   * ''The Ticket Subsystem'' 
     18     * TracTickets — Using the issue tracker. 
     19     * TracReports — Writing and using reports. 
     20     * TracQuery — Executing custom ticket queries. 
     21     * TracRoadmap — The roadmap helps tracking project progress. 
     22 * '''Administrator Guide''' 
     23   * TracInstall — How to install and run Trac. 
     24   * TracUpgrade — How to upgrade existing installations. 
     25   * TracAdmin — Administering a Trac project. 
     26   * TracImport — Importing tickets from other bug databases. 
     27   * TracIni — Trac configuration file reference.  
     28   * TracPermissions — Access control and permissions. 
     29   * TracInterfaceCustomization — Customizing the Trac interface. 
     30   * TracPlugins — Installing and managing Trac extensions. 
     31   * TracLogging — The Trac logging facility. 
     32   * TracNotification — Email notification. 
     33   * TracWorkflow — Configurable Ticket Workflow. 
     34   * TracRepositoryAdmin — Management of Source Code Repositories. 
     35 * [trac:TracFaq Trac FAQ] — A collection of Frequently Asked Questions (on the project website). 
    1136 
    12    Mostly anything you want to suggest or put on from yourself should start here, with a general discussion on the board. These method all developers can get involved into the decision before it goes into the wiki or ticket system and getting into the workflow (a developer for example could jump on the wiki while he develops and see the new suggestion and doesnt realize that its not really "voted" through, and develops something in that direction). So the forum should be the first place to mostly go. Beside you are responsible for the wiki page you want to edit, or responsible for the tickets you add. 
     37== Support and Other Sources of Information == 
     38If you are looking for a good place to ask a question about Trac, look no further than the [http://trac.edgewall.org/wiki/MailingList MailingList]. It provides a friendly environment to discuss openly among Trac users and developers. 
    1339 
    14  * '''Blog''' 
     40See also the TracSupport page for more information resources. 
    1541 
    16    The blog stands a bit out of the development and coordination stuff. Its mostly used to keep other people up to date what we do, and what grinds the gears of the developers. Anything written there is not suggested to be read by everyone, its just a drop out of personal thoughts, and doesnt go into discussion or into suggestion at all (beside you link from a forum entry to your blog entry for example). 
    17  
    18  * '''Wiki''' 
    19  
    20    Anything that is decided or nearly decided should go directly into the wiki, even tho it still could be that a developer or "the reality" denies the changes, it should be written down at the correct place so that other developers can see it. Generally the project is defined by the wiki and with our done-plugin ([blog:done-plugin-for-trac]) you can bind the wiki to tickets. 
    21  
    22  * '''Tickets''' 
    23  
    24    These is going more and more the most important place for coordinating the work. Later more and more people add tasks to the lists that has to be done, if a new link is ready, like if the modeller finishes up the playermodel and now needs a skin he sets a ticket for this on the ticketlist, then an graphican takes this ticket and executes it so that the skin gets ready. For now its all kept very simple but we will improve this point definitly. 
    25  
    26  * '''Pastebin''' 
    27  
    28    This pastebin you can use to show code, stuff or something else which is farly to big to go into the wiki or ticket itself. Or if you want to show something to some dudes on the IRC. If you are unfamiliar with pastebin services just try it out! 
    29  
    30  * '''Timeline''' 
    31  
    32    With the timeline you keep very good on track what happens in our trac at all. Anything done on the trac will be written done there, so that you can see directly what have changed and needs investigation. I suggest you to make this your "startpage" of ''Project !BattleCube'' like preparing a link on desktop or something like this to it, so that you can directly see whats going on. 
    33  
    34 [[BR]] 
    35  
    36 == General Trac Userguide == 
    37  
    38  * TracWiki -- How to use the built-in Wiki. 
    39  * TracTimeline -- The timeline provides a historic perspective on a project. 
    40  * TracRss -- RSS content syndication in Trac. 
    41  * ''The Version Control Subsystem'' 
    42    * TracBrowser -- Browsing source code with Trac. 
    43    * TracChangeset -- Viewing changes to source code. 
    44    * TracRevisionLog -- Viewing change history. 
    45  * ''The Ticket Subsystem'' 
    46    * TracTickets -- Using the issue tracker. 
    47    * TracReports -- Writing and using reports. 
    48    * TracQuery -- Executing custom ticket queries. 
    49    * TracRoadmap -- The roadmap helps tracking project progress. 
    50  * [http://trac.edgewall.org/wiki/TracFaq Trac FAQ] - A collection of Frequently Asked Questions (on the project website). 
     42Finally, developer documentation can be found in [trac:TracDev TracDev] and its sub-pages.