[INFRA-206] Create a document registry for Princeton provided documents Created: 08/Jun/18  Updated: 16/Aug/18  Resolved: 16/Aug/18

Status: Done
Project: Software Development Infrastructure
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Normal
Reporter: hassan Assignee: hassan
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

In general I assert that all documents circulated amongst the PFS team should have a document ID number for easy tracking and referencing (in emails and other documents).

The PFS Project Office have allowed individual institutions, based on general rules, to determine the ID numbers for documents. In order to ensure that those ID numbers are unique and follow the Princeton-specific rules, a persistent registry for Princeton documents should be established.

This registry should contain for each document the following information at least:

  • The document ID number
  • The full name of the document
  • The author name

 Comments   
Comment by hassan [ 08/Jun/18 ]

A simple realization of this registry is a simple CSV file with the above as fields, persisted in GitHub.

Comment by hassan [ 08/Jun/18 ]

An additional CSV file, containing:

  • The author name
  • The 2-digit author code

would also be useful.

Comment by shimono [ 11/Jun/18 ]

is there any reasonable/clear reason to separate this from commonly used ones like doc or *_doc?

Comment by hassan [ 11/Jun/18 ]

shimono I'm afraid I do not understand your question: when you say 'doc' or '*_doc', are you referring to a GitHub repository?

Yes, a short-term solution is to place the registry file (a CSV file) under GitHub, as mentioned in an earlier comment. There is no need to create a new, separate GitHub repository, if that is what your question is implying. I'm happy to use for example the doc repo https://github.com/Subaru-PFS/doc to store this information. I just need the green light from Project Office to do that.

Comment by shimono [ 19/Jul/18 ]

sorry leaving this ticket.
for new item (incl git repo, jira project, etc.) we use ticket for gathering information and tracking, but for editing repository (this time adding something into doc?) we just follow normal PR/r? procedure as usual repository, so I think you can create branch to show what will be implemented.
or, of course you can call naoyuki.tamura or email to the PO...

Comment by hassan [ 16/Aug/18 ]

Document registry for Princeton implemented in text form under GitHub successfully.

Generated at Sat Feb 10 16:50:29 JST 2024 using Jira 8.3.4#803005-sha1:1f96e09b3c60279a408a2ae47be3c745f571388b.