TPS UI help page

[pki-bot]

This issue was migrated from Pagure Issue #975. Originally filed by edewata (@edewata) on 2014-04-24 19:12:35:

• Assigned to nobody

---

The TPS UI should provide a help page that lists all TPS-related documentations. These documentations include:

• Manual pages (e.g. CLI man pages, server configuration man pages). A new servlet may need to be written to display the man page in the browser.
• Javadocs (e.g. PKI client API, PKI server API, TPS API if any).
• Wiki pages. These pages should be versioned (e.g. /wiki/Dogtag 10 TPS Configuration).

[pki-bot]

Comment from edewata (@edewata) at 2014-04-24 19:27:01

Displaying the man page in the browser can be done using the same code already in the CLI. See HelpCLI.java:

String manPage = ...

ProcessBuilder pb = new ProcessBuilder(
    "/bin/man", manPage);

... redirect process I/O to servlet I/O ...

Process p = pb.start();
int rc = p.waitFor();

[pki-bot]

Comment from mharmsen (@mharmsen) at 2014-04-29 02:29:38

Per CS/DS meeting of 04/28/2014 - 10.3.

edewata: 975 ideally should be 10.2 because it's like a man page but for the UI. but 10.3 is ok too. it's not crucial.

[pki-bot]

Comment from edewata (@edewata) at 2017-02-27 14:07:35

Metadata Update from @edewata:

• Issue set to the milestone: UNTRIAGED