Step 7 - Update Links

In the previous step, several pages were created to hold links for new documentation. Although, the page name was changed to reference the new version, the links on those new pages still point to the previous documentation (since the page is a copy of a page for a previous version).

All of the links on the new pages need to be updated to point to the new documentation. Since we try to keep page names consistent, (i.e. there is a "Administrators Guide" for Dorian 1.2, 1.3, and 1.4), this can be as simple as changing the space name from "spacename14" to "spacename15".

The key is to remember that any pages in a 1.4 space should reference 1.4 documents. Any pages that are named or refer to a specific version should contain links that reference that same version. Any content or text should be updated as well so that it applies to the new version.

Here is the list of pages again that need to have links updated:

There may be additional pages than the ones listed that need to have their links updated. Many of the Developer, Administrator, and other project pages will also need to be updated. This should be done when the content is updated by other developers, however, it doesn't always happen. Therefore, even if a page's content is updated by a developer or someone else in the KC, be sure to check that the links have been updated as well. However, do NOT update the links on any of the main landing pages (i.e. cagridhome:home, projects:home, documentation:home, downloads:home, etc.), since those links would be broken for anyone that is not logged in, such as the public. These pages will need to be updated when the release is made and the new documentation goes live.

Congratulations! Once all of the documentation is updated, the new pages are created, and the links are updated, you have finished preparing the documentation for the new release! Make sure to check all of your work and of the updates that others have made. Check navigation links and look at things while logged in and while not logged in to ensure that permissions are set properly. Now just wait around until the official release...

Step 6 - Create Additional Pages

Preparing for the Release - Create New Documentation