Changes between Version 4 and Version 5 of Install


Ignore:
Timestamp:
Apr 19, 2012 4:00:02 PM (2 years ago)
Author:
AdrianFritz
Comment:

Improve template with learned issues.

Legend:

Unmodified
Added
Removed
Modified
  • Install

    v4 v5  
    11= Install Instructions = 
     2 
     3 This page, by now is a template to be (maybe) used as a reference for hacks wiki pages. 
    24 
    35,,[[PageOutline(2-5,Contents,pullout)]],, 
    46 
    5 == Plugins == 
    6  1. '''Install''' 
    7    * Manually: 
    8      1. Download ... 
    9      2. Build egg if not previously available .... 
    10      3. Place the egg file at.... 
    11    * With easy_install: 
    12 {{{ 
    13 #!sh 
    14 $ [sudo] easy_install http://trac-hacks.org/svn/YOUR-SELECTED-PLUGIN/0.VV 
    15 }}} 
    16     or 
    17 {{{ 
    18 #!sh 
    19 $ [sudo] easy_install http://trac-hacks.org/svn/YOUR-SELECTED-PLUGIN/trunk/0.VV 
    20 }}} 
    21     * ,,`sudo` is optional case you already have enough authority to modify your server.,, 
    22  1. '''Restart''' your web server ,,(this example command line for Apache on Ubuntu),,. 
    23 {{{ 
    24 #!sh 
    25 $ [sudo] /etc/init.d/apache2 restart 
    26 }}} 
    27  1. '''Enable''' the plugin.  
    28    * by updating your [wiki:TracIni trac.ini] with this: 
    29 {{{ 
    30 [components] 
    31 ... 
    32 YOUR-SELECTED-PLUGIN.* = enabled 
    33 ... 
    34 }}} 
    35    * or accessing your Admin panel ({{{ ..admin/general/plugins }}}); 
    36  1. '''Configure''' your environment 
    37    * by modifiying `trac.ini` file; 
    38    * by accessing your Admin panel case you have WebAdminPlugin enabled; 
    39  1. '''Test''' your main environment and secondary ones 
    40    * plugin / macro is working properly? 
    41    * .... 
     7<---- TEMPLATE START HERE ---- > 
     8== Installation == 
    429 
    43 == Macros == 
     10  1. '''Be noticed''': 
     11     1. Below instructions should be specific for some O.S. Please, help expanding this instructions. 
     12     1. Broader installation guidelines are made available at [http://trac.edgewall.org/wiki/TracPlugins TracPlugins] 
     13     1. Sections not used, are suggested to be kept under comment. In future you might need it. For example: 
     14        {{{ 
     15        {{{ 
     16        #!comment 
     17        1. '''Check''' dependencies: 
     18           i. none required 
     19           * ,,`[sudo]` is optional case you already have enough authority to modify your server.,,[[BR]][[BR]] 
     20        }}}         
     21        }}} 
     22     [[BR]][[BR]]   
     23  1. '''Check''' dependencies: 
     24     i. none required 
     25     * ,,`[sudo]` is optional case you already have enough authority to modify your server.,,[[BR]][[BR]] 
     26  1. '''Install''' plugin:  
     27     * globally, with easy_install: 
     28       {{{ 
     29         #!sh 
     30         $ [sudo] easy_install https://trac-hacks.org/svn/YOUR-SELECTED-PLUGIN/0.VV 
     31       }}} 
     32        * ,,`[sudo]` is optional case you already have enough authority to modify your server.,, 
     33        * ,,You might be required to select a specific `tag`, `branch`. Defaults to select from `trunk`,,[[BR]][[BR]] 
     34     * Manually: 
     35       1. Download ... 
     36       2. Build egg if not previously available .... 
     37       3. Place the egg file at.... 
     38  1. '''Enable''' this component by updating [wiki:TracIni trac.ini] file as follows: 
     39     * by updating [wiki:TracIni trac.ini] file under appropriate configuration section; 
     40     {{{ 
     41     [components] 
     42     ... 
     43     YOUR-SELECTED-PLUGIN.* = enabled 
     44     ... 
     45     }}} 
     46     * or accessing your Admin panel ({{{ ..admin/general/plugins }}}, case you have WebAdminPlugin enabled);[[BR]][[BR]] 
     47  1. '''Configure''' environment as follows: 
     48     * by updating [wiki:TracIni trac.ini] file under appropriate configuration section; 
     49     {{{ 
     50     [YOUR-SELECTED-PLUGIN-SECTION] 
     51     <argument> = <value> 
     52     <argument> = <value> 
     53     }}} 
     54     * or accessing your Admin panel ({{{ ..admin/general/plugins }}}, case you have WebAdminPlugin enabled);[[BR]][[BR]] 
     55  1. '''Restart''' web server on command line: 
     56     {{{ 
     57     #!sh 
     58     $ [sudo] /etc/init.d/apache2 restart 
     59     }}} 
     60       * ,,`[sudo]` is optional case you already have enough authority to modify your server.,, 
     61       * ,,Above example command line is for Apache on Ubuntu.,,[[BR]][[BR]] 
     62  1. '''Test''' if this component is working properly (main environment and secondary ones if you have).  
     63     1. If this component is installed correctly, the configuration you have made should reflect on tickets.[[BR]][[BR]] 
     64     1. .... 
    4465 
    45  
    46 = Requirements = 
    47  
    48 == In case Easy Install == 
    49  
    50 == In case Build Eggs == 
     66<---- TEMPLATE ENDS HERE ---- > 
    5167 
    5268== This page Goals (& arguments) == 
    53  1. keep install instruction at only one place 
    54    * [+] different plugins / macros can refer to this page 
    55    * [+] a standard procedure 
    56    * [+] easy user's life 
    57    * [-] will be possible to adopt a single set of installation instruction? 
    58    * [-] redoing TracPlugins?? 
    59          * this have to be avoided (otherwise fails with this first goal) 
    60  1. standardize or reduce variance of install instructions 
    61    * [+] turn user's life easier  
    62    * [+] reduce mistakes 
    63    * [+] easy maintenance (for both plugin maintainer and user or I.T. staff) 
    64    * [+] guideline to plugin developers 
     69 
     70  1. keep install instruction at only one place 
     71     * [+] different plugins / macros can refer to this page 
     72     * [+] a standard procedure 
     73     * [+] easy user's life 
     74     * [-] will be possible to adopt a single set of installation instruction? 
     75     * [-] redoing TracPlugins?? 
     76           * [-] this have to be avoided (otherwise fails with this first goal) 
     77           * [+] TracPlugins have generic instructions and should be kept as a global reference 
     78           * [+] This should focus on a step by step one shot installation guideline, and must lower the entry barrier / tool adoption 
     79  1. standardize or reduce variance of install instructions 
     80     * [+] turn user's life easier  
     81     * [+] reduce mistakes 
     82     * [+] easy maintenance (for plugin maintainer, user and I.T. staff) 
     83     * [+] guideline to plugin developers 
    6584 
    6685=== Ways to improve this page === 
    67  * allow a page to pass parameters to, full fill automatically YOUR-SELECTED-PLUGIN 
     86 
     87Brainstorm: 
     88  * allow a page to pass parameters to, full fill automatically YOUR-SELECTED-PLUGIN 
    6889 
    6990== Known Issues ==