#975 TPS UI help page
Closed: migrated 3 years ago by dmoluguw. Opened 10 years ago by edewata.

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

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();

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.

Metadata Update from @edewata:
- Issue set to the milestone: UNTRIAGED

7 years ago

Dogtag PKI is moving from Pagure issues to GitHub issues. This means that existing or new
issues will be reported and tracked through Dogtag PKI's GitHub Issue tracker.

This issue has been cloned to GitHub and is available here:
https://github.com/dogtagpki/pki/issues/1541

If you want to receive further updates on the issue, please navigate to the
GitHub issue and click on Subscribe button.

Thank you for understanding, and we apologize for any inconvenience.

Metadata Update from @dmoluguw:
- Issue close_status updated to: migrated
- Issue status updated to: Closed (was: Open)

3 years ago

Login to comment on this ticket.

Metadata