IETF-Specific Information

Editing the Wiki and Issues

In order to create and edit wiki pages and issues, you need to log in. Click on the small 'Login' link above the main horizontal menubar. You log in with the same username (your email address) and password as for all other tools.ietf.org password protected accesses. If you don't have a login/passwd or need to reset your passwd, go to http://tools.ietf.org/newpasswd .

The login and password is also used to add files and commit changes to the source control repositories for IETF working group (scroll down for more information).

IETF-Specific Features

This Trac installation has a few IETF-specific features which are not generally found in Trac:

  • Occurences of RFC numbers or draft names in Wiki text will generate links to the RFC or draft in question. Unless you want to point to an RFC or draft in a specific location which is different from the automatically generated link, you don't need to explicitly add links for RFCs and drafts. Examples: RFC 2026, draft-ietf-poised95-std-proc-3
  • Each issue in the issue tracker can be indicated to concern a 'component'. This is a standard Trac feature; however, the list of available components is automatically updated to include all the active working group drafts. This makes it easier to associate issues with drafts for the WG participants, without the Chairs needing to go in as admin users and add a new component each time there's a new WG draft.
  • The 'Severity' field of an issue has a special significance if the issue type is set to 'state' or 'task'. In that case, the Severity will be shown as an annotation to the draft state on the regular WG status page on tools.ietf.org. This can be useful for WG chairs to indicate more exactly the state of a WG draft, which will otherwise simply be indicated as 'Active' on the status page, until it is sent to the IESG for processing.
  • If issues are registered against a draft, indicated by setting the issue's 'component' field to the appropriate (abbreviated) draft name, the status page will show a progress bar, indicating the total number of issues for that draft, as well as the proportion which have been closed, and the number of still open issues.

Issue tracker changes which are reflected in the WG status pages ('Severity' annotations and issue progress bars) may take up to 1 hour to propagate from the server which hosts the Trac instance (trac.tools.ietf.org) to the other tools servers.

Integration with tools.ietf.org

For all working groups which have an instance of Trac installed, the URL to Trac for that WG has the form http://tools.ietf.org/wg/<wg>/trac. There's also a link to the Trac issue tracker and a link to the Trac wiki in the horizontal menu on the WG status page http://tools.ietf.org/wg/<wg> once Trac has been installed.

Source Control Repository (SVN)

Source control is good. Although many people think of source control as something that applies only to software code, it is also very helpful for documents, such as the Internet-Drafts that are considered by IETF working groups.

Each working group that has a Trac instance automatically also has a source control repository using the Subversion ("SVN") tool. The URL for each repository is of the form http://svn.tools.ietf.org/svn/wg/<wg>. Anybody can check out from the repository, but in order to add files and commit changes to the repository you need to use your credentials (username and password) on the tools server. If you don't have credentials, you can create them at http://trac.tools.ietf.org/newlogin

To check out a repository with a command-line SVN client, see this example for the hybi WG:

work/ $ svn checkout https://svn.tools.ietf.org/svn/wg/hybi/

To modify a document already in the repository, first check out the directory (as above) and then commit the change:

hybi/ $ emacs draft-foo-bar-baz.xml
hybi/ $ svn commit draft-foo-bar-baz.xml -m "fixed spelling of 'Mordor'" 

To add a document to the repository, place the document in your SVN working folder, tell SVN it should be added, and when ready, commit it to the repository:

work/ $ cd hybi/
hybi/ $
hybi/ $ svn add draft-foo-bar-baz.xml
A draft-foo-bar-baz.xml
hybi/ $ svn commit draft-foo-bar-baz.xml -m "Commit message ..." --username=someone@example.com

Note that the value of the --username option is the email address you used to register with the tools server (i.e., the username part of your credentials). You will be prompted for your password:

Password for 'someone@example.com':
Adding         draft-foo-bar-baz.xml
Transmitting file data .
Committed revision 1.

The IETF Trac instances use a variation of the Trac SVN hook script which is provided with Trac. This script updates Track Issue Tickets based on keywords in the SVN commit messages; the keywords and their use is described in SvnTracHooks.

The foregoing mini-HOWTO is very basic. For more details about Subversion commands, please see the documentation at http://subversion.apache.org/