The Trust and Identity Document Repository is found here. |
Internet2 Trust and Identity's document stewardship process is intended to formalize the management of documents as they are drafted, proposed, vetted, and approved for use, and published for open access. It is intended to address any documents that are products of work sponsored by Trust and Identity or one of its community advisory groups. Examples of such products include:
Note that any software documentation for developers and end users that is related to a specific release of the software, and is distributed with software, is vetted as part of the quality assurance process for the software release and is out of scope for Trust and Identity Document Stewardship. Documents describing software lifecycle management, overall system architecture, etc., however, are in scope.
CACTI (Community Architecture Committee for Trust and Identity) is charged with oversight of the document stewardship processes.
The foundational document establishing and governing the Document Stewardship process is found here (click on the link to the PDF).
Submissions to the Document Repository must be approved by a Sponsor. The authorized Sponsors are::
For a document that will eventually go into the repository, it is recommended to get a document ID and format the document with the needed components during the time that you are developing the document, prior to it being finalized. (You will submit the document to go into the repository later when it has been finalized and approved.)
To prepare a document to go into the Document Repository:
1. The cover page should include this info below, though only the Title, copyright and the licensing info are strictly required
Document Title
Repository ID
Persistent URL
Authors (provide authors names in all cases and their ORCID where possible - e.g., Scott Koranda <http s://orcid.org/0000-0003-4478-9026>)
Publication Date
Sponsor
Note: You obtain the Repository ID and Persistent URL from the librarian. Also note that the authorized Sponsors are listed in Trust and Identity Document Stewardship. See Document Repository Metadata Element Definitions for more information.
2. This copyright and licensing info must be on the first page of the document (where <year> is the current year).
© <year> Internet2
This work is licensed under a Creative Commons Attribution 4.0 International License.
See example HERE FIX THIS EMILY!
3. When the document review phase is complete, a community consultation has been completed if appropriate, and the sponsor has approved the final version, then the document is ready to be put in the repository.
Send the document to ti-librarian@internet2.edu in both of these formats:
text (preferred) or HTML
PDF, unless that is not appropriate for the specific document
At this time, you may also propose the following metadata elements to the librarian, as appropriate:
See Document Repository Metadata Element Definitions for more information about these optional items.
After you submit the document in two formats of the document to the librarian, the librarian will attach them to the corresponding page in the repository and those will become the authoritative copies.
Here is an example of a repository page that has the attachment of the authoritative doc.
An updated document is a new document with its own new row in the document repository, even though much of its content may be the same as the original document.
Just as with the original document, the update is subject to review and approval, as specified by its sponsor.
There are a few of things to note:
The "Deprecated" field of a document's repository metadata page will be set to "yes" when its content should no longer be trusted to reflect current practice or thinking on its topic. As noted above, this occurs when a document is superseded by another, but it can also occur without a superseding document.
Note that, in order to maintain a historical record, documents are never removed from the repository, unless they were placed in error. Documents that no longer have anything other than historical interest are deprecated.
Working group chair and flywheel guidelines with regard to the Document Stewardship process are found here.
Please contact David Walker <dwalker@internet2.edu> or Emily Eisbruch <emily@internet2.edu> for more information.
Document Stewardship Process - Framework Docs
See Also
Trust and Identity Document Repository Index
Community Review of the Doc Stewardship plans
Guidelines for Trust and Identity Working Group Chairs and Flywheels