Improvement suggestion: versioned documentation

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

Improvement suggestion: versioned documentation

Nils Steinger
Dear Monit developers,

currently, the online documentation only covers the most recent Monit
version: https://mmonit.com/monit/documentation/monit.html
However, due to packaging delays and version freezes for various *nix
distributions, it is often not possible to have the most recent version
installed at all times.

It would be very helpful to keep the documentation for previous versions
online when a new version is released.
That way, a user could quickly check the docs for their Monit version
without having to connect to their actual Monit machine.
It would also make it possible to run diff on two documentation versions
to get a quick overview of any new features or changed configuration
options (more concise and less confusing than digging through all
release notes, since the changes from one release might have been
changed again by a later one).

The change could be as easy as renaming monit.html to something like
monit-5.23.html and symlinking monit.html to the most recent version on
your server.
Alternatively, there are also externally hosted solutions like
readthedocs.org that can re-generate the directory structure
automatically whenever a new commit is made or a new version is
released.

Could you please consider implementing this?
The usability improvement it provides would be much appreciated.

Kind regards,
Nils Steinger

--
To unsubscribe:
https://lists.nongnu.org/mailman/listinfo/monit-general
Reply | Threaded
Open this post in threaded view
|

RE: Improvement suggestion: versioned documentation

Roose, Marco
Hi,
another option could be to move to ReadTheDocs as they provide versioning of
the documentation.

Kind regards,
Dr. Marco Roose

-----Original Message-----
From: monit-general
[mailto:monit-general-bounces+marco.roose=[hidden email]] On
Behalf Of Nils Steinger
Sent: Sunday, September 24, 2017 5:47 PM
To: [hidden email]
Subject: Improvement suggestion: versioned documentation

Dear Monit developers,

currently, the online documentation only covers the most recent Monit
version: https://mmonit.com/monit/documentation/monit.html
However, due to packaging delays and version freezes for various *nix
distributions, it is often not possible to have the most recent version
installed at all times.

It would be very helpful to keep the documentation for previous versions
online when a new version is released.
That way, a user could quickly check the docs for their Monit version
without having to connect to their actual Monit machine.
It would also make it possible to run diff on two documentation versions to
get a quick overview of any new features or changed configuration options
(more concise and less confusing than digging through all release notes,
since the changes from one release might have been changed again by a later
one).

The change could be as easy as renaming monit.html to something like
monit-5.23.html and symlinking monit.html to the most recent version on your
server.
Alternatively, there are also externally hosted solutions like
readthedocs.org that can re-generate the directory structure automatically
whenever a new commit is made or a new version is released.

Could you please consider implementing this?
The usability improvement it provides would be much appreciated.

Kind regards,
Nils Steinger

--
To unsubscribe:
https://lists.nongnu.org/mailman/listinfo/monit-general

--
To unsubscribe:
https://lists.nongnu.org/mailman/listinfo/monit-general

smime.p7s (8K) Download Attachment