As discussed on freeipa-users mailing list ([link to discussion]), it would be useful to add new FreeIPA subpackage "docs" which would package https://fedorahosted.org/freeipa-guide/ FreeIPA user documentation along with the product (PDF and HTML format).
It would be also useful to add a link in Web UI to this documentation when if freeipa-docs package is installed. Web UI should either detect that the doc is installed or the doc package could deploy a simple Web UI plugin (and appache docs) adding the link to itself. If the doc package would do server changes, we may name it freeipa-server-docs and make freeipa-server it's dependency.
freeipa-docs
freeipa-server-docs
freeipa-server
dialog example from RHEV-M 3.2 <img alt="help-step1.png" src="/freeipa/freeipa/issue/raw/files/405de498c1aae19f09b99e1141bb67e0bd09c7d5627bcccda43cc0e91f48ad4c-help-step1.png" />
on-line documentation opened via the "?" icon <img alt="help-step2.png" src="/freeipa/freeipa/issue/raw/files/73687760c61e88c34de7e2a0fc790880ac9a36faf02133865b95febcce33552e-help-step2.png" />
I like the way how on-line documentation works in RHEV-M (from version 3.2). See attachments [[attachment:help-step1.png]] and [[attachment:help-step2.png]].
Good idea. If we ship docs along with the package, we could pretty easily add help links to Web UI with anchors to the docs.
3.4 development was shifted by one month, moving tickets to reflect reality better.
How are the current docs on https://fedorahosted.org/freeipa-guide/ parsed from XML to HTML?
How should this be approached if the docs are in a separate repository?
This repository was forked into a new one. You can find more info on wiki: http://www.freeipa.org/page/Contribute/Documentation
Note that the Web UI interactive doc and a build of the package is not implemented yet.
We decide to push this out of 3.4, it is not a priority for this release.
Having online up-to-date documentation will be enough for now (see related doc tickets).
Closing the request - see http://www.freeipa.org/page/Upstream_User_Guide for the reasoning.
Metadata Update from @mkosek: - Issue assigned to someone - Issue set to the milestone: Future Releases
Login to comment on this ticket.