Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

We only fix problems in the upcoming release documentation, we will not fix any problems in already released versions. This is because it is possible that the people changing the current space will forget to add it to the space containing the documentation for the new version. With this approach we ensure that the upcoming documentation contains the fix and thus all new versions (the change is not lost)

That means:

...

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".