Authoring Platform Version 6+ User Guide

Page tree

Versions Compared

Old Version 1

changes.mady.by.user Steve Archbold

Saved on

compared with

New Version 2

changes.mady.by.user Steve Archbold

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info
titleIn this page:

Authoring projects are managed and configured in the Authoring Platform (AP) underlying workflow instance (Jira), using particular field configurations, issue types, workflows and permissions schemes. The process is outlined here to show the underlying platform dependencies and steps to prepare a project for SNOMED CT content authoring, but managing them for the International Authoring Platform is currently a SNOMED International Technical Team support activity. Please note this is not a detailed definition of the support activity steps or Jira setup requirements - those are available in other Technical Team process documentation.




Info
titleJira project ticket

An authoring project is defined by a "project" type ticket in Jira which must exist for that project to be seen in the AP projects list (it's not sufficient just to create a Jira project).


Info
titleJira product code

Project visibility in the Authoring Platform depends on a "product code" (Jira custom field) set in the project ticket. Particular Authoring Platform deployments are configured to use a particular product code (or list of codes). This allows a single Jira instance to support projects across multiple Authoring Platform deployments if needed.



Advanced Tables - Table Plus
classuser-guide-steps-references


StepsReferences
Press the Raise an Issue button in the lower right of any page footer.
Enter the desired project details. The more information included the better, but the minimum needed is a new project name (this will be what appears in the AP projects listings) and a brief summary of its purpose. Confirmation of which Authoring Platform, a preferred project key satisfying Jira key conventions, and in particular a reference to any similar existing projects, can significantly simplify and hence speed up the process, although these can also be inferred/defined by the Technical Team if not specified.
Submit the Raise an Issue form. For the International Authoring Platform this creates a Devops Support (INFRA) ticket, which the Technical Team will use to track implementation of the following steps as soon as resources and scheduling permit (your patience is appreciated!):

Create a new project in the Jira workflow instance associated with the Authoring Platform, and associate the project schemes with those needed for content authoring.

Technical Team support activity.
Create a new "project" ticket type in the new project. Ensure that the "product code" matches that configured for the Authoring Platform deployment.Technical Team support activity.
Verify the new project is appearing in the Authoring Platform.Technical Team support activity.
Create test task in the new project and perform a search to initialize the project branch in the Terminology Server.Technical Team support activity.
Notify the request originator (INFRA ticket reporter) that the new project is ready for use in the Authoring Platform.Technical Team support activity.