| 1 | = IETF-Specific Information = |
| 2 | |
| 3 | == Editing the Wiki and Issues == |
| 4 | |
| 5 | In order to create and edit wiki pages and issues, you need to log in. Click on the |
| 6 | small 'Login' link above the main horizontal menubar. You log in with the same |
| 7 | username (your email address) and password as for all other ''tools.ietf.org'' password |
| 8 | protected accesses. If you don't have a login/passwd or need to reset your passwd, go |
| 9 | to http://tools.ietf.org/newpasswd . |
| 10 | |
| 11 | The login and password is also used for commits to the SVN repository. See more about |
| 12 | the repository further down. |
| 13 | |
| 14 | == IETF-Specific Features == |
| 15 | |
| 16 | This Trac installation has a few IETF-specific features which are not generally found |
| 17 | in Trac: |
| 18 | |
| 19 | * Occurences of RFC numbers or draft names in Wiki text will generate links to the |
| 20 | RFC or draft in question. Unless you want to point to an RFC or draft in a |
| 21 | specific location which is different from the automatically generated link, you |
| 22 | don't need to explicitly add links for RFCs and drafts. Examples: RFC 2026, |
| 23 | draft-ietf-poised95-std-proc-3 |
| 24 | |
| 25 | * Each issue in the issue tracker can be indicated to concern a 'component'. This is |
| 26 | a standard Trac feature; however, the list of available components is automatically |
| 27 | updated to include all the active working group drafts. This makes it easier to |
| 28 | associate issues with drafts for the WG participants, without the Chairs needing to |
| 29 | go in as admin users and add a new component each time there's a new WG draft. |
| 30 | |
| 31 | * The 'Severity' field of an issue has a special significance if the issue type is |
| 32 | set to 'state' or 'task'. In that case, the Severity will be shown as an |
| 33 | annotation to the draft state on the regular WG status page on tools.ietf.org. |
| 34 | This can be useful for WG chairs to indicate more exactly the state of a WG draft, |
| 35 | which will otherwise simply be indicated as 'Active' on the status page, until it |
| 36 | is sent to the IESG for processing. |
| 37 | |
| 38 | * If issues are registered against a draft ,indicated by setting the issue's |
| 39 | 'component' field to the appropriate (abbreviated) draft name, the status page |
| 40 | will show a progress bar, indicating the total number of issues for that draft, as |
| 41 | well as the proportion which have been closed, and the number of still open issues. |
| 42 | |
| 43 | * Everywhere you can use wiki markup (on the wiki pages, roadmap descriptions, |
| 44 | etc.) you may embed a macro which shows a ticket statistics graph. Full |
| 45 | information about the macro is available at [http://trac-hacks.org/wiki/TicketStatsMacro]. |
| 46 | Briefly, the macro syntax is: |
| 47 | {{{ |
| 48 | [[TicketStats( height=250,daterange=12m,res_days=30)]] |
| 49 | }}} |
| 50 | which gives this result: [[TicketStats( height=250,daterange=12m,res_days=30)]] |
| 51 | |
| 52 | Issue tracker changes which are reflected in the WG status pages ('Severity' |
| 53 | annotations and issue progress bars) may take up to 1 hour to propagate from the |
| 54 | server which hosts the Trac instance (trac.tools.ietf.org) to the other tools servers. |
| 55 | |
| 56 | == Integration with tools.ietf.org == |
| 57 | |
| 58 | For all working groups which have an instance of Trac installed, the URL to Trac for |
| 59 | that WG has the form '''''!http://tools.ietf.org/wg/<wg>/trac'''''. |
| 60 | There's also a link to the Trac issue tracker and a link to the Trac |
| 61 | wiki in the horizontal menu on the WG status page |
| 62 | '''''!http://tools.ietf.org/wg/<wg>''''' |
| 63 | once Trac has been installed. |
| 64 | |
| 65 | == SVN Repository == |
| 66 | |
| 67 | For each WG with a Trac instance there is also a SVN repository, with an URL of the |
| 68 | form '''''!https://svn.tools.ietf.org/svn/wg/<wg>'''''. Anybody can check out from |
| 69 | the repository, but you need to use the tools server login and password in order to |
| 70 | commit to the repository. |
| 71 | |
| 72 | To check out a repository with a command-line svn client, see this example for the ''hybi'' WG: |
| 73 | |
| 74 | {{{ |
| 75 | work/ $ svn co --username=henrik@levkowetz.com https://svn.tools.ietf.org/svn/wg/hybi/ |
| 76 | work/ $ cd hybi/ |
| 77 | hybi/ $ |
| 78 | }}} |
| 79 | |
| 80 | SVN also lets you check out parts of the repository tree, but for more info on |
| 81 | that, please see the documentation on http://subversion.apache.org/. |
| 82 | |
| 83 | To add a document to the repository, place the document in your SVN working folder, |
| 84 | tell SVN it should be added, and when ready, commit it to the repository: |
| 85 | {{{ |
| 86 | hybi/ $ svn add draft-foo-bar-baz.txt |
| 87 | hybi/ $ #... |
| 88 | hybi/ $ svn commit draft-foo-bar-baz.txt -m "Commit message ..." |
| 89 | hybi/ $ |
| 90 | }}} |
| 91 | |
| 92 | The IETF Trac instances use a variation of the Trac SVN hook script which is provided |
| 93 | with Trac. This script updates Track Issue Tickets based on keywords in the SVN |
| 94 | commit messages; the keywords and their use is described in SvnTracHooks. |