Thank you Fred!
This is such important work for the overall project.
Kind regards
Stan
On 21/12/2017 9:39 pm, Fred Gleason wrote:
Howdy Folks:
Today’s release of v2.18.0 of Rivendell includes a major overhaul of
the documentation. Here are some of the highlights:
1) Operations Guide. The Rivendell Operations Guide has been
completely rewritten, expanded and retitled “The Rivendell Operations
and Administration Guide”, with new chapters covering RDAdmin,
recently added Rivendell modules and more. The source for the Ops
Guide has also been translated from Open Document (ODT) format to
DocBook 5 and incorporated as part of the Rivendell sources (in
‘docs/opsguide/‘). Both HTML and PDF versions are included in the
standard tarball.
2) Miscellaneous Notes. The gaggle of miscellaneous notes previously
found in the ‘docs/‘ directory have now mostly been incorporated into
the Ops Guide as appendices. The few remaining exceptions can be found
in the docs/misc/‘ directory. Most of these will likely eventually
end up in the Ops Guide as well.
3) API Specs. The various API specifications for Rivendell’s internal
protocols have likewise been converted to DocBook 5, and can be found
in ‘docs/apis/‘. Both HTML and PDF versions are shipped in the
standard tarballs.
4) Accessing the Guide. When installed from source, the Operations
Guide will be installed in ‘/usr/share/rivendell’, with a new
‘Documentation’ submenu beneath the ‘Rivendell’ desktop menu that
contains links to open both HTML and PDF versions. For those using the
standard CentOS RPM packages, install the ‘rivendell-opsguide’ package
to get the documentation and links.
5) Errata. This rewrite has been a huge undertaking and I’m sure that
many typos and other errata still exist. Please feel free to report
such. Even better: fix it and send a pull request!
Cheers!
|----------------------------------------------------------------------|
| Frederick F. Gleason, Jr. | Chief Developer |
| | Paravel Systems |
|----------------------------------------------------------------------|
| There are two ways of constructing a software design. One is to |
| make it so simple that there are obviously no deficiencies; the |
| other is to make it so complicated that there are no obvious |
| deficiencies. The first method is far more difficult. |
| --C.A.R Hoare |
|----------------------------------------------------------------------|
_______________________________________________
Rivendell-dev mailing list
Rivendell-dev@lists.rivendellaudio.org
http://caspian.paravelsystems.com/mailman/listinfo/rivendell-dev
_______________________________________________
Rivendell-dev mailing list
Rivendell-dev@lists.rivendellaudio.org
http://caspian.paravelsystems.com/mailman/listinfo/rivendell-dev
