nitrc:Future User Guide - Tool/Resource Registration

From NITRC Wiki

Users: Getting Started | Browse | Search | Compare | Upload/Download | Personalize | Features

Administrators: Getting Started | Registration | Administration | Other Features

You must be logged in to register a new software tool, community, discussion group, database, or other resource. Click the Register New Tool or Resource sub-menu link below the "Tools & Resources" main menu link. You need to insert the following information to register a tool/resource:

Required Fields—indicated by a red asterisk (*)

Full Name: The official name of the tool/resource. This is the name that will be displayed on the NITRC site. As the tool/resource administrator, you may change this name after registration through your Admin Edit Public Info page.

Purpose and Summary: A brief summary of the tool/resource. This description will be used by the NITRC team to decide whether to approve your tool/resource. This is not the public description—that is entered below.

License: The license (if any) for your tool/resource. If your tool/resource license is not in the list of existing license, select "Add new license" below the list and enter a name and a description of your license in the appropriate boxes.

Public Description: A description of the tool/resource. This description will appear on the Tool/Resource Summary page. As the tool/resource administrator, you may change this description after registration through your Admin Edit Public Info page.

Unix Name: This is how the NITRC database will identify your tool/resource. This name must respect the following rules:

1. Its length must be between 3 and 15 characters.
2. It must be lower case.
3. Only letters, numbers, underscores, and dashes are accepted.
4. It cannot match the Unix name of any other tool/resource.
5. It cannot match one of our reserved domains.

Note: The Unix name will be used in NITRC URLs. Although you might change the public name of your tool/resource as it develops, the Unix name can never change.

SCM: You have a choice of two source code management systems for your tool/resource. You may select CVS or SVN. Once you have registered your tool/resource, you will not be able to change the SCM. If you intend to use git for version control, choose either CVS or SVN here and read about Git Administration after registration for instructions on setting up a git repository on NITRC.

Optional Fields:

Organization: The organization (such as Johns Hopkins University, UCSD, or Neuroinformatics Research Group) that supports this tool/resource. As the tool/resource administrator, you may add or change the organization after registration through your Admin Edit Public Info page.

Center: The research center or institute (such as Motefiore Institute, CIRM, or Center for Systems Biology) that supports this tool/resource. As the tool/resource administrator, you may add or change the center after registration through your Admin Edit Public Info page.

Forge Import: NITRC has the ability to automatically pull in pages from an existing GForge-based site. If your tool/resource already resides in SourceForge or a GForge environment, you may provide your existing site's URL and specific Project ID here. NITRC will automatically set up your tool/resource links to redirect to your "Forge" site. In the event that invalid links to your SourceForge or GForge environment are generated, the NITRC moderator will contact you directly to complete the registration process. Once your registration is approved, you can remove or modify any of the links to the "Forge" site through your Admin Custom Tool Menu Entries page. Please refer to that section of this User Guide for more information on managing NITRC tool/resource menu links.

Forge URL: The address of your SourceForge or GForge-based site. Make sure you enter the full URL, including the protocol identifier such as "http://" or "https://". (Note: This field is required if a Project ID is entered.)

Project ID: The ID assigned to your SourceForge or GForge-based project. This ID is displayed as the group_id in the address bar of your browser for most of your "Forge" pages. (Note: This field is required if a Forge URL is entered.)

Display with NITRC Menu: Check this box if you would like the NITRC banner and menu system to be displayed when your "Forge" pages are shown.

Click the "Submit" button to send the tool/resource registration to the NITRC site administrators for approval. This approval step is to ensure that only functional and structural neuroimaging tools/resources are part of NITRC. When the tool/resource is approved, you will receive an e-mail message from the NITRC site administrators confirming that the tool/resource is active. You may want to refer to the Getting Started section of this User Guide for more information on setting up your recently registered tool/resource.

Private Tools/Resources: All tools/resources registered with NITRC are initially made available to the public, but tool/resource administrators do have the option to make their tools/resources available only to members. There are two ways to make your tool/resource private:

1. Click the "Admin" link in your tool/resource menu. To the right of the Admin page, in the Group Members section, click the "Edit Observer" button. Here you change the tool/resource privileges setting from "Public" to "Private." If you later wish to make your tool/resource available to the public, follow these same steps, and change the tool/resource privileges setting from "Private" to "Public."
2. Click the "Admin" link in your tool/resource menu. Click "Edit Public Info" at the top of the page. Toward the top of the page, to the right of the "Descriptive Name" field, select the "Private" radio button for "Tool/Resource Visibility." If you later wish to make your tool/resource available to the public, follow these same steps, and select the "Public" radio button for "Tool/Resource Visibility."