DRAFT ION: ION Store

Name: ion-ion-store
Title: The ION Store
Draft date: 2007-10-11 21:45 UTC
To be approved by: IESG
Discussion forum: ietf@ietf.org
Editors Cullen Jennings, Brian Carpenter

File Naming

Each ION is stored as a file (for text IONs and HTML IONs without images), or as a file + a directory for HTML IONs with images. The name of the file is "ion-" + the rest of the name of the ION + the format suffix. This document would be "ion-ion-store.html". A copy exists in the "dated" subdirectory of all IONs ever approved. The file name of the document in the "dated" subdirectory is the basic name + the date in ISO format + the format suffix. Thus, this document would be "ion-ion-store-2006-07-23.html" if it was approved on June 23, 2006. If there is an associated directory with images or others files, the drafts directory will have separate copy of the directory for each dated version of the ION.

An HTML ION generated with XML2RFC will also have an associated .xml file in the repository.

HTTP Access to IONs

The IONs can be found at:

The standard HTTP URL for the current version of this document would then be "http://www.ietf.org/IESG/content/ions/ion-ion-store.html", and the stable URL to the dated version would be "http://www.ietf.org/IESG/content/ions/dated/ion-ion-store-2006-07-23.html".

HTTP Access to Drafts

Drafts open for public comments can be downloaded with HTTP at:

All drafts can downloaded with HTTP at:

The draft version of this document would be found at http://svn.tools.ietf.org/svn/group/iesg/ions/drafts/ion-ion-store.html

In addition, old version of drafts and differences between them can be found using the web tools starting at:

Subversion Access to Drafts

To modify or create a new ION, you will need an account on the tools server and you will need to use SVN. Go to http://www1.tools.ietf.org/newlogin to create a new account or recover your password. SVN is available as a command line tool for most operating systems. Windows users might want to try out the following SVN client, http://tortoisesvn.tigris.org and some Apple folks like the plug-in at http://scplugin.tigris.org.

The whole repository can be checked out using a command line version of SVN with the following command:

This will ask you to accept the TLS certificate. You may also need to enter your account name and password. Note that your account name is likely of the form somebody@example.com and is not just the "somebody" part.

The cheat sheet for SVN is:

svn update Fetch latest copy of files from the repository.
svn add fileName Add a new file to the repository. You will need to do a commit after this.
svn commit fileName Save the changes made to a file to the repository.

For more information on using SVN, look at http://subversion.tigris.org/.

Publishing to the IETF Website

When a draft ION is open for public comment, or once the draft ION is approved, it needs to be copied to the IETF website. This is done in a few stages. In the SVN repository, it is copied to the main directory and the dated directory, being careful to preserve any images or other files if there is an associated directory. Various parts of the files may need to be edited including links to images and the template information about when it was approved. Once this is all correct, the files need to be copied to the IETF web server.

The files are copied to the IETF server by sending an email to one or more of the people that can copy these files. This currently consists of brc@zurich.ibm.com and fluffy@cisco.com. One of these people will check that the content looks good, then copy over all the files from the tools server to the IETF server and then send email indicating this was done to the people requesting the copy.

The files are copied to the IETF web server by doing an svn update to get the latest files, and then doing an "sftp iesgcontent@utgard.ietf.org:incoming" and putting the appropriate files onto the server. Then a SYNCNOW file is uploaded. For this file, the commands would be

In less than an hour or so, the files should be automatically synced to http://www.ietf.org/u/iesgcontent/ which http://www.ietf.org/IESG/content/ is aliased to.

Intellectual Property Issues

IONs count as IETF contributions, so are subject to BCP 78 and BCP 79. Since they will not include technical specifications, this is mainly a formality.

Future Changes

In the future, it would be nice to have rsync and ftp access to the IONs.