From 1c64895114867b057e73180d59d7c15f202418fd Mon Sep 17 00:00:00 2001 From: arhonemus <34036628+arhonemus@users.noreply.github.com> Date: Thu, 9 May 2024 14:02:44 -0400 Subject: [PATCH 1/3] Callout config and transfer pages --- _config.yml | 20 ++++++++++++++++++++ transfers/Completing-transfer.md | 6 ++++-- transfers/preparing-for-transfer.md | 21 ++++++++++++++------- 3 files changed, 38 insertions(+), 9 deletions(-) diff --git a/_config.yml b/_config.yml index 29169c7..d76a26d 100644 --- a/_config.yml +++ b/_config.yml @@ -16,3 +16,23 @@ heading_anchors: true ga_tracking: G-4GBB05KF5M ga_tracking_anonymize_ip: true + +callouts_level: quiet # or loud +callouts: + highlight: + color: blue + important: + title: Important + color: yellow + new: + title: New + color: green + note: + title: Note + color: purple + warning: + title: Warning + color: red + construction: + title: Under Construction + color: yellow \ No newline at end of file diff --git a/transfers/Completing-transfer.md b/transfers/Completing-transfer.md index 2944da2..703f6c3 100644 --- a/transfers/Completing-transfer.md +++ b/transfers/Completing-transfer.md @@ -20,8 +20,10 @@ This page outlines the steps to take after transferring media. (Refer to transfer instructions for the format you are transferring) ## Verifying all packages meet requirements -Under Construction -{: .label .label-yellow} + +{: .construction } +packaging instructions to follow + * Run the packaging script ## Updating records in SPEC diff --git a/transfers/preparing-for-transfer.md b/transfers/preparing-for-transfer.md index 778dbc9..fd486ed 100644 --- a/transfers/preparing-for-transfer.md +++ b/transfers/preparing-for-transfer.md @@ -16,8 +16,9 @@ This page outlines the steps to take before transferring media objects. ## Locating Carriers * Carriers are located on shelving by the entrance door * Carriers to be transferred are likely on `02.**` shelves -* -**Before a media object can be imaged it first must be recorded SPEC.** + +{: .important } +Before a media object can be imaged it first must be recorded SPEC. ## Verifying SPEC records An acquisition record should exist in SPEC and SPEC object records should exist @@ -43,7 +44,8 @@ for each carrier being transferred. * Select search -**Contact Collection Management if you cannot find the acquisition** +{: .warning } +Contact Collection Management if you cannot find the acquisition ### Verifying object records exist in SPEC * Select the acquisition from the list @@ -86,7 +88,8 @@ src="preparing-for-transfer/SPEC-object-records.png" /> * Confirm the number of items listed for Digital media matches the object records * Report mismatch of digital media summary and object records to Systems and Operations -**Contact Collection Management if the number of carriers and records don't match** +{: .highlight } +Contact Collection Management if the number of carriers and records don't match ### Verifying additional carriers from Archival Processing When archivists survey a collection they may find additional carriers in boxes. @@ -94,16 +97,20 @@ Archivists should create object records for any carriers they find and notify Digital Archives of their discovery. * [Verify](#verifying-object-records-exist-in-spec) objects records exist in SPEC -**Contact the processing archivist if the number of carriers and records don't match** +{: .highlight } +Contact the processing archivist if the number of carriers and records don't match ### Handling Commercial Software -**These instructions are for Digital Preservation staff (including fellows) only.** + +{: .note } +These instructions are for Digital Preservation staff (including fellows) only. * Label commercial software with a simple acquisition name. * `Crouch` for Stanley Crouch papers. * Image commercial software only when specifically instructed to do so. * Commercial software media don't receive objects records. -**When objects records were created for commercial software create an issue.** +{: .highlight } +When objects records were created for commercial software create an issue. * Select issues from the object record menu in SPEC
From ca002a18c58ece5ef22a61d18fc593d2f881f28c Mon Sep 17 00:00:00 2001 From: arhonemus <34036628+arhonemus@users.noreply.github.com> Date: Thu, 9 May 2024 15:57:59 -0400 Subject: [PATCH 2/3] added deprecated callout to config --- _config.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/_config.yml b/_config.yml index d76a26d..fc3135b 100644 --- a/_config.yml +++ b/_config.yml @@ -35,4 +35,7 @@ callouts: color: red construction: title: Under Construction - color: yellow \ No newline at end of file + color: yellow + deprecated: + title: Deprecated + color: red \ No newline at end of file From 8f60a14ffd3d74e3402e78c88501b920f510c69b Mon Sep 17 00:00:00 2001 From: Nick Krabbenhoeft Date: Thu, 20 Jun 2024 10:32:40 -0700 Subject: [PATCH 3/3] added instructions for callouts --- _config.yml | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/_config.yml b/_config.yml index fc3135b..1c2c02e 100644 --- a/_config.yml +++ b/_config.yml @@ -19,23 +19,31 @@ ga_tracking_anonymize_ip: true callouts_level: quiet # or loud callouts: - highlight: - color: blue - important: - title: Important +# use for documentation still not fully complete, but partially launched + construction: + title: Under Construction color: yellow +# use after launching new documentation for external staff, remove after some period time new: title: New color: green +# use for legacy instruction that will eventually be removed, remove when documentation is removed + deprecated: + title: Deprecated + color: red +# use to callout requirements before starting process + important: + title: Important + color: yellow +# use for context to instructions note: title: Note color: purple +# use for situations where no further work should be completed until situation is resolved warning: title: Warning color: red - construction: - title: Under Construction - color: yellow - deprecated: - title: Deprecated - color: red \ No newline at end of file +# use for final instruction or failure remediation + highlight: + color: blue +