Access Keys:
Skip to content (Access Key - 0)

Notation

Step 2 - Update Project Spaces and Navigation


There are several things that need to be update in every versionized project. Parts A, B, and C, need to be done for each versionized project.

Part A: Update Left Hand Navigation


Any "versionized" project needs it's main/general project space's navigation updated. For example, since Introduce is a versionized project space, the navigation for the project, located at "introduce:navigation" needs to be updated. By updating the navigation page in the general project space, the changes will be replicated in all of the project version spaces (i.e. introduce13, introduce14). Links to guides for the latest version should be present just off of the "Documentation" menu while links to older documentation should be in the "Previous Version" submenu.

Complete the following steps for all versionized project spaces.

  1. Navigate to spacekey:navigation (note: make sure it is the general project space and the project space for a particular version)
  2. Select Edit this page
  3. Create a new "sub-submenu" for the (now) old version of caGrid under "Previous Versions" for the "Documentation" menu.
    {submenu}[Previous Versions|Documentation By Version]
    {sub-submenu}x.x
    
  4. Copy and paste the links of the (now) old documentation from {menu}[Docmentation] to under {sub-submenu}x.x
  5. Ensure that the links for the version are just under {menu}[Documentation]

For example, if 1.4 was just released, the end result would be this:

{menu}[Documentation|Documentation]
{menuitem}[Administrators Guide 1.4|introduce14:Administrators Guide]{menuitem}
{menuitem}[Design Guide 1.4|introduce14:Design]{menuitem}
{menuitem}[Developers Guide 1.4|introduce14:Developers Guide]{menuitem}
{menuitem}[Extensions 1.4|introduce14:Extensions]{menuitem}
{menuitem}[Tutorials 1.4|cagrid14:Tutorials]{menuitem}
{submenu}[Previous Versions|Documentation By Version]
{sub-submenu}1.3
{menuitem}[Administrators Guide|introduce13:Administrators Guide]{menuitem}
{menuitem}[Design|introduce13:Design]{menuitem}
{menuitem}[Developers Guide|introduce13:Developers Guide]{menuitem}
{menuitem}[Extensions|introduce13:Extensions]{menuitem}
{menuitem}[Tutorials|cagrid13:Tutorials]{menuitem}
{sub-submenu}

Part B: Update "by Version" Pages


Each general project space (for versionized projects) has a Downloads by Version and Documentation by Version. These need to be updated to include links to the latest release.

Complete the following steps for all versionized project spaces.

1. Downloads By Version

  1. Using the Site Map for the space or the link for "Download other versions of..." on the "Downloads" page, navigate to spacekey:Downloads By Version
  2. Click Edit this page...
  3. Following the format that is already there, add a header and link to the Downloads page of the latest release.
    1. The link should be "[Download PROJECTNAME x.x|spacekeyXX:Downloads]
    2. For example:
      h2. caGrid WS-Enumeration 1.4
      [Download caGrid WS-Enumeration 1.4|wsenumeration14:Downloads]
      
  4. Save the page.

2. Documentation By Version

  1. Using the Site Map for the space or the link for "Documentation for other versions" on the "Documentation" page, navigate to spacekey:Documentation By Version
  2. Click Edit this page...
  3. Following the format that is already there, add a header and links to the guides for the latest release.
    1. For example:
      h3. [CDS 1.4|cds14:Documentation]
      ----
      * [Administrators Guide|cds14:Administrators Guide]
      * [Design|cds14:Design]
      * [Developers Guide|cds14:Developers Guide]
      * [Users Guide|cds14:Users Guide]
      
  4. Save the page.

Part C: Update Landing Pages


In the general space for each versionized project, there is a Downloads and a Documentation page. These pages use an {include} to display the documentation for the latest release – which is the documentation page in the latest project version space (the newest release). Both of these pages will need to be updated.

Complete the following steps for all versionized project spaces.

1. Update Downloads Page

  1. Using the left navigation on the left, navigate to the Downloads page in the general project space. (spacekey:Downloads)
  2. Click Edit this page...
  3. Change the {include} macro to include the Downloads page for the new release.
    1. For exaxmple, if 1.4 was the newest release, you would change {include:introduce13:Downloads} to {include:introduce14:Downloads}
  4. Save the page

2. Update Documentation Page

  1. Using the navigation on the left, navigate to the Documentation page in the general project space. (spacekey:Documentation)
  2. Click Edit this page...
  3. Change the {include} macro to include the Documentation page for the new release.
    1. For exaxmple, if 1.4 was the newest release, you would change {include:introduce13:Documentation} to {include:introduce14:Documentation}
  4. Save the page
Last edited by
Sarah Honacki (710 days ago)
Adaptavist Theme Builder Powered by Atlassian Confluence