Documentation Spaces

One documentation space per Version

The inspectIT documentation will copy the concept of Atlassian (vendor of confluence) w.r.t. documentation. For each version of inspectIT there will be a separate space in the wiki that reflects the documentation for this version. So users of an older version of inspectIT can still get a hold on the old documentation without being affected by the documentation changes that we did for the newer versions. In addition to that we profit from this approach as we can separate the documentation of the currently released version from the documentation of the version that is currently developed. inspectIT uses a documentation space per major release. This allows us to easily navigate our users to the correct documentation. Features and Improvements that are implemented in a newer version can thus be integrated in the documentation of the new version without confusing users of older versions.

Documentation Space Naming Convention

The documentation space for an inspectIT version is DOC followed by the major version of inspectIT (without dot separators), thus DOC15 is the Space Key for the documentation on inspectIT 1.5. The name of the space should be "Documentation (majorversion)"

Creating a new documentation space

For each new major version, a new documentation space needs to be created. As we need to base on the documentation of the old documentation, the old space needs to be copied. For the copying process we use the "Space Copy Addon".