- Are the backslash preceding $IPF_ETC and \$INSTALL_DIR intentional? E.g.,
"IPF workflows are typically defined by JSON files under \$IPF_ETC/ipf/workflow/, particularly in \$IPF_ETC/ipf/workflow/glue2."
- Sometimes $IPF_ETC is used and other times $IPF_ETC_PATH. Pick one.
- In some cases, footnotes are used to reference external sites and other times, it is inlined as a hyperlink. Seems like inlined would be easier for people to find unless you can make that footnote ref clickable. Usually citations are in square brakets that's why it looked a bit funny to me. E.g.,
"Before installing IPF operators should register their resource in RDR (4)."
"To install IPF on machines that are part of multiple XSEDE resources please first review XSEDE's Advanced Integration Options documentation."
- In prerequisites, can you elaborate what is the minimal information that needs to be registered in RDR before installing IPF? It's not obvious why it's a prerequisite and an SP may not have all the info as they are prepping a new resource to come online (e.g., various dates).
- The "Preparing to Install IPF" section looks like Prerequisites to me. I would move the content that section to be first under the "Pre-Requisites" section.
- I would also change this bullets as follows:
"Install and run IPF on a single server for each resource." to "Identify a single server to run IPF -- a single IPF instance can be used to publish information for multiple resources."
- You need to describe the authentication options before this sentence. "If IPF will authenticate to Information Services using a X.509 host key/certificate..." , the public and private keys must be readable by the user running IPF."
- I think we should get rid of this sentence and any references to xdresourceid since we plan to retire it before the end of XSEDE.
"(Optional) The xdresourceid tool. If not available a resourceid will need to be configured by hand."
- In the RPM section, you say "Note(s): - The RPM will automatically create an "xdinfo" account that will own the install and that will execute the workflows via sudo." but yet in the Pip section, you don't mention creating a user account. In the Prerequisites section, you should probably add a bullet about deciding between Pip or RPM and the benefits/tradeoffs of one versus the other.
- Under "Pre-configuration templates" section, the formatting looks a bit scrunched like it's missing newlines. There's also repetitive text about how to find the site_packages dir.