Issue Number | 4318 |
---|---|
Summary | Modify Documentation for PDQ Partners |
Created | 2017-09-22 15:02:21 |
Issue Type | Improvement |
Submitted By | Englisch, Volker (NIH/NCI) [C] |
Assigned To | Englisch, Volker (NIH/NCI) [C] |
Status | Closed |
Resolved | 2018-04-25 16:58:20 |
Resolution | Fixed |
Path | /home/bkline/backups/jira/ocecdr/issue.214661 |
Since we're removing a bunch of document types from the set of documents provided we want to update the PDQ partner documentation accordingly.
The documentation for the partners is out of date since our Fermi release. I'm adding the ticket to Hawking.
I'm realizing that this ticket can be done outside of a release and we have two options to give our partners access to the documentation:
as before we'll keep all documentation in the docs directory of the FTP server. We have write permission to this directory and can make updates outside of a release.
all of the documentation should be part of our github repository (currently it is not) and we could point our partners to that gibhub repository.
a combination of the former two options. Keep the documentation in the docs directory with a link to github for the most up-to-date information.
Currently our partner documentation includes a section which lists our DTD. This may have made sense when the file pdq.dtd was not part of the documentation directory. However, since we've changed the location of the DTD to be included in the documentation directory - the same directory where all other partner documentation can be found - I'm going to remove that section from the Word document and only refer to the PDQ DTD. In addition to removing about 20 pages from the document this change will also eliminate the step of having to update this document after every DTD change.
I'm trying to move the updated file to our SFTP docs directory but
I'm getting a permission denied error.
I need to submit a ticket to CBIIT to have this fixed.
After CBIIT adjusted the permissions I was able to copy the updated documents to PROD.
The documentation has been added to the cdr-publishing
repository:
https://github.com/NCIOCPL/cdr-publishing/commit/2d15d2ef
Elapsed: 0:00:00.001191