Step 3 - Update Navigation

Once the permissions have been changed, it is safe to add links in the navigation menu to the documentation in the new spaces. Since the permissions are set so that only users can view the page, users must log in to see any pages in the new version spaces. Therefore, we can add the links to the navigation menu to make it easier to navigate to the pages without having to worry about the public seeing the pages. By adding the pages to the navigation now, it also cuts down on the amount of time it will take to update the documentation once the release is made.

There is a navigation page for nearly every space. There certainly is a navigation page wherever a space has a left hand navigation menu. For versionized project spaces, each project version space will have a navigation page that has a simple {include:mainprojectspace:Navigation}. This pulls the navigation from the main project space and displays it. This is extremely beneficial since it means that we will only have to update the navigation for the main project space and the changes will be reflected in each version space. We only have to update the navigation once instead of 3 or 4 times.

Update the Navigation for Project Spaces

1. Browse to the navigation page of the main/general project space. For example, introduce:Navigation or http://cagrid.org/display/introduce/Navigation
2. Select Edit this page
3. After "{menu}[Documentation]"Add the following wiki markup:

   {menuitem}[Administrators Guide X.X|spacekeyXX:Admninistrators Guide]{menuitem}
   {menuitem}[Developers Guide X.X|spacekeyXX:Developers Guide]{menuitem}
   {menuitem}[Users Guide X.X|spacekeyXX:Users Guide]{menuitem}
   {menuitem}[Design Guide X.X|spacekeyXX:Design Guide]{menuitem}
   

   Replace X.X with the new release number and "spacekeyXX" with the proper project spacekey for the new release.

4. Save the page.
5. Repeat these steps for all project space

While we try to standardize project spaces, each service is different. Therefore, there are different guides for each service. In general, there is a Developers, Administrators, Users, and Design Guide. However, some projects do not have a Users Guide, while others do not have a Developers or Administrators Guide. Some spaces have additional guides or tutorials. Check the site map of the new version space and confirm with the rest of the team to establish what guides are going to exist in the new project version. You may have to update the navigation for spaces a few times as guides and other documentation is added or deleted throughout the update process.

See The Navigation Menu for complete details and syntax.

Step 2 - Change Permissions

Preparing for the Release - Create New Documentation

Step 4 - Create New Macros