From ec172b0f7a68f5d388e0d729286ddf8fd87c8171 Mon Sep 17 00:00:00 2001 From: Julia Afeltra <30803904+jafeltra@users.noreply.github.com> Date: Tue, 21 May 2024 10:33:21 -0400 Subject: [PATCH] Update releaseLabel configuration to reflect current value and best practices (#92) --- content/docs/SUSHI/configuration/_index.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/content/docs/SUSHI/configuration/_index.md b/content/docs/SUSHI/configuration/_index.md index b4840e2..6c0efe0 100644 --- a/content/docs/SUSHI/configuration/_index.md +++ b/content/docs/SUSHI/configuration/_index.md @@ -70,15 +70,12 @@ If the author wants SUSHI to do additional Implementation Guide (IG) processing, * `retired`: The IG has been withdrawn or superseded and should no longer be used. * `unknown`: It is not know which of the status values currently applies for the IG. This should be rare. * Since SUSHI currently supports only FHIR R4 and R5, the `fhirVersion` should always be `4.0.0` or above. -* Valid values for the `releaseLabel` include: - * `ci-build`: the continuous integration build release (not stable) - * `draft`: draft version - * `qa-preview`: frozen snapshot for non-ballot feedback - * `ballot`: frozen snapshot for ballot - * `trial-use`: official release with 'trial use' status - * `release`: official release for use - * `update`: official release with 'trial use' status - posted as an un-balloted STU update - * `normative+trial-use`: official release with mixture of trial use and normative content +* `releaseLabel` is a text label with no fixed set of values that describes the status of the publication to users. Recommended best practices include the following values, optionally suffixed with `Ballot`: + * `ci-build` + * `STU1`, `STU2`, etc. + * `STU 1.1`, `STU 1.1.0`, etc. + * `Normative 1`, etc. + * `Informative 1`, etc. {{% alert title="Tip" color="success" %}} SUSHI can generate a simple configuration file for you with the `init` [command](/docs/sushi/project/#initializing-a-sushi-project)