[Pki-devel] [PATCH] 475 Converted TPS connector docs into man page.

[Endi Sukma Dewata]

Thanks for the comments. Please find the attached revised patch.

I changed the man page name from pki-tps-connector to 
pki-tps-connector-config to avoid a possible conflict with the man page 
for pki-tps-connector CLI. Right now the CLI is called "pki 
tps-connection" but I'm planning to change it to "pki tps-connector" for 
consistency.

Please see the comments below.

On 4/24/2014 11:18 AM, Christina Fu wrote:
> 1. Under CA connector,
>      "+This property contains the URI to contact TKS for the operation
> <op>."
>   I think you meant "...contact CA..." not "...contact TKS..."

Fixed.

> 2. For CA connector, I should have provided instruction on how to
> configure revocation routing.
>       a. add past signing CA's cert nickname as such (the CA's signing
> cert should already be in the nss db and trusted):
>             tps.connector.ca<n>.caNickname=<signing ca nickname>
>       b. when the first revocation is triggered, you might notice a new
> parameter added to the config, which is the automated generated Base64
> encoded CA SKI.  e.g.
>              tps.connector.ca1.caSKI=a/OJajZmIucFjKQa4rJxvvUZmBo=

Do you mind writing something that I can copy & paste it into the man 
page? I don't think I'm familiar enough with it to write a proper 
documentation. Or if you prefer you could send a separate patch on top 
of this patch.

> 3. You probably want to remove the old conn stuff: conn.xxx

OK. I'll do that in patch #476 because that's where we remove the old 
code that refers to conn.xxx.

> 4. Maybe create a separate ticket...per discussion on irc, we want to
> create a "main man page" that lists out all man page key words one can
> man for our product.  This is so that people know where to look for info
> now that they are gone from CS.cfg.  Once created, we should put a one
> line that points them to the main man page to look for info, perhaps in
> CS.cfg's, admin ui's, cli's etc.

I created these tickets:
https://fedorahosted.org/pki/ticket/976
https://fedorahosted.org/pki/ticket/975

Also, as mentioned over IRC I created a list of manual pages:
http://pki.fedoraproject.org/wiki/Dogtag_10_Manual_Pages
To avoid confusion I'm going to add the Dogtag versions in which the 
pages were added.

> thanks,
> Christina

-- 
Endi S. Dewata
-------------- next part --------------
A non-text attachment was scrubbed...
Name: pki-edewata-0475-1-Converted-TPS-connector-docs-into-man-page.patch
Type: text/x-patch
Size: 15840 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/pki-devel/attachments/20140424/725fc05b/attachment.bin>