Deploying a finished product

From the Deployment page, you can do the following:

Downloading and staging software images and release notes

You can download software images and documentation from the Deployment page.

To download software images and release notes from the Deployment page:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click the Deployment link on the Page Navigator.
  4. In the activities area in the Work Products column, click the link for downloading releases.
    Note that the activity area is either directly below the page navigation toolbar or at the top of the page. It is the area with a light blue background.
  5. Click the link for the information you want to download.

To stage software images and release notes from the Deployment page:

  1. In the Deployment directory of the project template for the project, navigate to the snippets directory for software.
    For example, you may go to My-Project /trunk/www/cn-project-pages/stages/Deployment/software/snippets/top.html.
    Where My-Project is the name of your project.
  2. Using Subversion, update the top.html. file in the snippets directory.
  3. Edit the appropriate row of the release images table in the top.html file, for example, you might edit the following:
    <tr class="a">
    <td>[1.0]</td>
    <td>[Link - Your Release Image]</td>
    <td>[<a href="/nonav/cn-project-pages/help/customizing_alm_links.html"
    onclick="return launch(this.href, 1);" title="Note: link may open in new window"
    class="helplink">Link - TBD</a>]</td>
    <td>[<a href="/nonav/cn-project-pages/help/customizing_alm_links.html"
    onclick="return launch(this.href, 1);"
    title="Note: link may open in new window" class="helplink">Link - TBD</a>]</td>
    <td>[TBD]</td>
    <td>[TBD]</td>
    </tr>
  4. In the table row, replace "/nonav/cn-project-pages/help/customizing_alm_links.html" with the name of the software image file in your project's version control repository.
  5. You can change onclick="return launch(this.href, 1);" to onclick="window.open(this.href); return false;" to make the link open in a normal-sized browser window instead of the smaller-sized window.
    Remove onclick="return launch(this.href, 1);" if you do not want the link to open a page in a new browser window.
    Remove or edit title="Note: link may open in new window" to modify the text that appears in a tool tip when the user moves the cursor over the link.
    Remove class="helplink" if you do not want the cursor to be a question mark icon for this link.
  6. To ensure that the shading of the rows of this table alternates between light and dark grey, check the class attribute on the TR tag and ensure that these tags alternate between "class=a" and "class=b".
  7. Commit the changes using your version control tool.
  8. Using your version control tool, submit your changes.
  9. Commit the changes.

Finding incident reports and action items that are relevant to the Deployment subpage

The following procedures describe how to find incident reports and action items that are relevant to the Deployment subpage.

To view incident reports associated with the Deployment subpage:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click the Deployment requirement that may be considered for inclusion in the product.
    View active incident reports queued for resolution - View incident reports that have a Queued for Resolution attribute value that is set to Yes and a Status attribute value of Submitted, Started, On hold, or Reopened.
    View active incident reports flagged for discussion - To view incident reports that have a Flagged for Discussion attribute value of Yes. The value of the Status attribute is Submitted, Started, On hold, or Reopened.
    View active incident reports flagged for FAQ - To view incident reports that have a Flagged for FAQ attribute value of "Yes." The value of the Status attribute is Submitted, Started, On hold, or Reopened.

To view action items associated with the Deployment subpage:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click the Deployment icon on the Page Navigation toolbar or the Deployment link in the left navigation pane.
  4. In the Action Items column of the activity area, click one of the following:
    Note that the activity area is either directly below the page navigation toolbar or at the top of the page. It is the area with a light blue background:
    Add new action item - To enter an action item, for example, conducting a code review or uploading a nightly build results document. To have these action items appear on the Deployment page, set the Action Item Type to Deployment.
    View active action items that are flagged for discussion - To view action items that have a Flagged for Discussion attribute value that is set to Yes and a Status attribute value of Submitted, Started, On hold, or Reopened.
    View active action items that are specific to deployment - To view action items that have an Action Item Type attribute value of Deployment, and a Status attribute value of Submitted, Started, On hold, or Reopened.
    View active action items of any type - To view action items that have a Status attribute value of Submitted, Started, On hold, or Reopened.

Adding and modifying incident reports and action items on the Deployment page

Note that incident reports are only viewed on the Deployment and Project Management pages.

To add an incident report or action item that is returned on a query on the Deployment page:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click the Deployment link on the Page Navigation toolbar or in the left navigation pane.
  4. Click Add new in the activity area, in either the Incident Report or Action item column
    Note that the activity area is either directly below the page navigation toolbar or at the top of the page. It is the area with a light blue background.
  5. Enter the required information for the requirement, defect, or action item.
  6. If prompted, click Next.
  7. For an incident report, complete the required information.
    For an action item, in the Submission Information section, select Deployment from the Action Item Type drop-down list.
    This ensures the artifact is returned on a query issued from the Deployment page.
    Also for an action item, if you want the action item to appear on a milestone query on the Project Management page, select the appropriate milestone from the Target Milestone drop-down list.
  8. Click Save Changes.

Reading and creating deployment documentation

You can access project documentation from a Documentation table on the Deployment page. If you are responsible for authoring deployment process documents, you can download templates for these documents from this page and upload draft or final documents. You or the project administrator can also add new documentation templates to the list.

If you have a content developer role in the project, (or have both VersionControl - Commit and VersionControl - Add permissions granted by an administrator), you can also add information to this page as well as view this page. However, the project administrator may prefer to take requests for additions to this page and be the sole person who actually performs the updates.

The documentation table on this page contains a View other project documents link. Clicking this link is equivalent to clicking the Documents and files link in the left navigation pane.

Important: If you experience any difficulty uploading documents on this page, ask your project administrator to be sure that two Subversion integrations settings are turned off for the project. The administrator should click the project link on the Projects page, clickEdit project > Tool configuration, then turn off the Message must name artifact and Committer must own artifact settings in the Subversion section of the page.

To view project documentation on the Deployment page:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click the Deployment link on the Page Navigation toolbar or the left navigation pane.
  4. Scroll to the Process Documents table.
  5. Click the link for the document that you want to read.

To download a project document template from the Deployment page:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click the Deployment link on the Page Navigation toolbar or the left navigation pane.
  4. In the Process Documents section, click the View document templates link.
  5. Click the link for the template that you want to edit.
  6. Save this file locally and edit it.

To add or update a project document on the Deployment page:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click the Deployment link on the Page Navigator.
  4. In the Process Documents section, click the Upload document link.
  5. Browse to the document that you want to upload.
  6. Click Save.
    Note that this document is saved in the project's version control repository. If you want to rename or delete this document, you must use your version control client.

Viewing and adding work products

In addition to the links for staging software and release notes, on the Deployment page, there are links in the activity area to various work products. The activity area is either directly below the page navigation toolbar or at the top of the page. It is the area with a light blue background.

A project administrator may have replaced the link to the deployment system with live data. However, if this has not been done, you can configure these links. You can also add deployment metrics documents at any time.

To upload deployment metrics documents:

  1. Click the Projects page and click the link for the project where you want to add this documentation.
  2. Click Deployment on the page navigation toolbar or in the left navigation pane.
  3. In the Work Products column of the Activities area, click View deployment metrics.
    The activity area is either directly below the page navigation toolbar or at the top of the page. It is the area with a light blue background.
  4. On the Requirements Documents page, click Upload document.
  5. Browse for the file and click Save.

To configure the work products link to the deployment system:

  1. If you have not done so already, use Subversion to check out the project template directory.
    For example, you may check out My-Project/trunk/www/cn-project-pages
    Where My-Project is the name of the project you are working on.
  2. Use your version control tool to update the Code & Build top.html snippet.
    For example, using Subversion, this will be in My-Project/trunk/www/cn-project-pages/Stages/Deployment/snippets/top.html
  3. Open the top.html file in an editor.
  4. In the section for work products, edit the following link:
    <div class="launch_icon"> 
    Launch systems: 
    </div> 
    <!-- onclick="return launch(this.href, 1);" makes the link open in a small new window --> 
    <!-- Use onclick="window.open(this.href); return false;" to make the link open in a normal-sized new window --> 
    <!-- Edit the title to change tool tip -->
    <ul>
    <li><a href="/nonav/cn-project-pages/help/customizing_alm_links.html" 
         onclick="return launch(this.href, 1);" title="Go to a Web-enabled requirements management application 
         [Note: link may open in new window]" class="helplink">Deployment system</a></li>
    </ul>

    For example, you might substitute the following:

    <li><a href="http://www.your_url_here.com/" 
    onclick="window.open(this.href); return false;" 
    title="Go to a Web-enabled deployment application">
    Requirements system</a></li>
    As shown in the example, you can change onclick="return launch(this.href, 1);" to onclick="window.open(this.href); return false;" to make the link open in a normal-sized browser window instead of the smaller-sized window.
    Remove onclick="return launch(this.href, 1);" if you do not want the link to open a page in a new browser window.
    Remove or edit title="Go to a Web-enabled deployment application [Note: link may open in new window]" if you do not want text to appear in a tool tip when the user moves the cursor over the link.
    Remove class="helplink" if you do not want the cursor to be a question mark icon for this link.
  5. Submit your changes.

Customizing the Resources links

At the bottom of the Deployment subpage, you can provide information that points users to any other information that you think is relevant.

To edit the Resource Links table:

  1. If you have not done so already, use Subversion to check out the project template directory.
    For example, you may check out My-Project/trunk/www/cn-project-pages
    Where My-Project is the name of the project you are working on.
  2. Use Subversion to update the Deployment bottom.html snippet.
    For example, using Subversion, this will be in My-Project/trunk/www/cn-project-pages/Stages/Deployment/snippets/bottom.html
  3. Open the bottom.html file in an editor.
  4. In the section for resource links, edit a row in the table, such as the following:
    <tr class="a">
    <td>Customizing the ALM Baseline Project template</td>
    <td><a href="http://www.collab.net/training/alm/Customizing_ALM.doc" onclick="window.open(this.href); return false;" title="Note: link may open in new window">http://www.collab.net/training/alm/Customizing_ALM.doc</a></td>
    </tr>

    For example, you can remove onclick="window.open(this.href); return false;" if you do not want the link to open a page in a new browser window.
    Or, you can remove or edit "title="Note: link may open in new window"" if you do not want text to appear in a tool tip when the user positions the cursor over the link.
  5. Alternate between class="a" and class="b" to provide different shades of gray in the table.
  6. Using Subversion, update this file and commit the changes.