Versions Compared

Key

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

Table of Contents
maxLevel2
stylesquare


excerpt
Panel
borderColorblack
titleColorblack
titleWe have three platforms where we discuss or document our annotation work

We have three platforms where we discuss or document our annotation work:

  • Slack for discussing vocabulary and reporting issues with the annotation tools
  • Confluence for documenting guidance and reporting vocabulary issues
  • JIRA where vocabulary issue tickets are logged and software development work is tracked

Table of Contents

title
Panel
borderColorblack
titleColorblack
Who has access?
  • Cochrane Information Specialists
  • Anyone

    who is

    working on

    Linked Data projects 
    Panel
    borderColorBlack
    titleColorblack
    titleConfluence (guidance is stored here)

    LinkedData should have access to these tools.

    If you do not yet have access contact Deirdre Beecher.



    Slack

    What do we use Slack for?

    • to communicate directly with each other or in groups
    , either written or by calling
    • to
    post queries and suggestions in the #annotation channelto
    • share files and posts
    we
    • to post udpates on annotation guidance
    or 
    • , tool development
    ,
    • and troubleshooting
    Who has access

    What can I post to the annotation channel?

    • comments & suggestions
    • general questions about annotation issues
    • request for help with annotations (or if you want someone to check your annotation)
    • reporting issues with the tools

    How do I post to the #annotation channel

    • just type and hit your enter key
    • to alert a particular member of the team insert @ before their name 
    • remember that posts in this channel can be viewed by all members

    How do I send a direct (private) message

    If you wish to send a private message to one or more people use the direct message option:

    1. Click on + beside Direct Message at the bottom of the lefthand column
    2. Begin to type name of contact in the search box and the name will arrive at the top of the list beneath the search box
    3. Enter multiple names if you wish to create a group
    4. When ready click on GO

    Confluence

    Confluence is project collaboration software which links with JIRA.

    Who has access

    Every Cochrane Information Specialist or other persons who are working on PICO annotation for Cochrane should have access.

    How to change your password

    If for any reason you need to change your password please follow instructions provided HERE.

    What do we use Confluence for?

    • storing our guidanace documents
    • creating spaces and pages for keeping notes
    • requesting terms 

    CRG

    Confluence

    Confluence is project collaboration software which links with JIRA.

    Who has access

    Every Cochrane Information Specialist or other persons who are working on PICO annotation for Cochrane should have access.

    How to change your password

    If for any reason you need to change your password please follow instructions provided HERE.

    Your

    Space

    • Each CRG has their own Space in Confluence where they can store any documentation related to their annotation work
    .
    • - how you want to use this space is entirely up to you!
    • On the main page of this Space a form has been provide for reporting vocabulary issues
    .
    • To find your Space click on Image Addedfound on the blue menu bar at the top of the page, and then on Space directory to search
    • Information on how to add new pages or edit existing ones in your Space can be found HERE
    Info
    titleDo NOT remove coding from HTML box when editing Space home page

    CRGs can add and remove any information as they wish however it is important not to remove the coding in the HTML box as this will disable the reporting form for vocabulary issues.

    Block email notifications

    Blocking notifications from Confluence

    Guidance for using Confluence

    Creating a page

    Expand
    titleExpand for step-by-step guide
    ActionDescription1

    Click on Create in the blue menu bar at top of page to create a blank page

    Image Removed

    2Click on the 3 dots beside Create to open up a list of templates - use only if you want something other than a blank page3Select the template you wish to use and click on create

    Image Removed

    4When page is completed click on publish

    Image Removed

    Annotation Guidance

    Block email notifications

    When changes are being made to various pages you may receive a number of unwanted email alerts. If you wish to block them please see Blocking notifications from Confluence.


    JIRA 

    What do we use JIRA for?

    • tracking software development
    • logging vocabulary requests

    our two boards are LDD and LDO 

    Editing a page

    Expand
    titleExpand for a step-by-step guide

    Action

    Description

    1Go to Space home page2Click on Edit at the top of the screen

    Image Removed

    3Before you can structure your page you need to add a title after which the horizontal edit menu bar will be available

    Image Removed

    4Vary the page layout. Here you are given options to divide the page into sections, or multiple columns. When you click on the icon a second edit menu bar will appear.

    Image Removed

    Image Removed

    5Insert macros. This is useful if you want to insert table of contents, information boxes etc.

    Image Removed

    Info

     If you require more information or more advanced options click on Image Removed at top of page.

    If you have questions or would like some more information added here please contact Deirdre (dbeecher@cochrane.org)

    Report a Vocabulary Issue form

    Excerpt

    Embedded on the home page of each CRG Space, is a vocabulary issue reporting form. Even though the title is Raise Preferred Vocab Term Issue, any vocabulary issue can be raised here, i.e. add a term, merge a term.

    Once you have completed the form and clicked on Submit the issue will be logged on JIRA (click HERE for more information).

    In each CRG Space, pages have been added with tables for resolved and open vocabulary issues.

    As the status of these issues changes these tables automatically update.

    Expand
    titleExpand for How to use the Vocabulary Issue Form

    Action

    Description

    1Click on the button provided on your space page.

    Image Removed

    2Insert the term in the field provided.

    Image Removed

    3Select the PICO component or components for which the term is required.4Select the vocabulary action required.Add, Merge, etc.5Select your Group from the drop-down list.

    Image Removed

    6Add the CD number of the review.7

    Provide your name and email address. These fields are provided at the bottom of the form.

    This helps if we need to contact the person who submitted the request.

    Image Removed

    8Click on Submit.9Any information that you might feel relevant to your request should be included in any of the fields provided.Annotation Knowledge Base

    This is a repository for guidance on annotation and can be found HERE.

    HTML
    																																<a href="#com-atlassian-confluence">Back to Top</a>

    JIRA 

    JIRA is used for project and issue tracking for both vocabulary and tool issues, and tool development.

    Who has access

    Every Cochrane Information Specialist or other persons who are working on PICO annotation for Cochrane should have access.

    LDD and LDO

    We have two boards LDD and LDO where we can monitor and track progress of all logged issues.

    Expand
    titleExpand for descripton LDD and LDO boards


    BoardsFull titleDescription
    LDDLinked Data DevelopmentThis board logs tooling related issues such as, ongoing and new development work, bugs, global changes needed for annotation interface etc.
    LDOLinked Data OntologyThis board logs vocabulary related issues such as, terms to be added or merged, etc.
    Terms requested using the Report a Vocabulary Issue form


    Requesting vocabulary terms

    • Each request generates a JIRA ticket which in turn creates further discussion about individual terms on JIRA
    .
    • If you are asked for feedback about a vocab request, you will receive an email notification from JIRA
    . To respond to these messages, click on the JIRA link for the vocab request within the email (rather than responding to the email). You will be prompted to enter your JIRA ID and password. You can then leave comments on the JIRA page for that request. 

    Search JIRA for vocabulary issues

    • within JIRA it is possible to search for any requests that you have made
    • you can limit your search to your name, Group, PICO etc. 

    The following are some examples of how to search for your requests

    Search by requester/reporter name

    Open Vocabulary Issues page shows progress of JIRA tickets. 

    Expand
    title
    Expland here for explanation of JIRA LDO statusesStatusDescriptionDonethe vocab issue is fixed & ready to use in LiveReady for Editorshould be fixed very soonReady for Developmentnot something we can fix with the editor, but ready for us to pass on to DataLanguageSolution Identifiedwe could fix it with the editor, but we're waiting for some development from DataLanguage, e.g. there are several vocab requests that will be fixed with LDO 278Consultationwe have asked one or more Information Specialists for their expertise

    Responding to comments on my JIRA ticket term request

    ExcerptSometimes more information is required from the requester and this is inserted as a comment on the the JIRA ticket that was generated for the specific request. This in turn will generate an email alert to be sent to the requester. To respond we ask that you click on the link to the ticket within the email rather than responding to the email.
    Click here to open up table


    StepActionImage
    1Login to JIRA

    Image Added

    2Click on Issues and then on Search for Issues

    Image Added

    3Click on Type All and scroll down to Vocabulary Issue and select

    Image Added

    4Click on More and find Reporter (label for person who submitted the request) on list. Once you have selected this option the system will automatically open up a drop-down list of names for you to search. 

    Image Added

    5The drop down list will give you a number of suggestions, probably based on previous searches or you can begin to type the name in the search field

    Image Added

    6You also have the option to select a particular status

    Image Added


    Search by Cochrane Group 

    Expand
    titleClick here to open up table


    StepActionImage
    1
    Click on the JIRA ticket link (title of request) within the email that you receive to your email inbox

    Image Removed

    2

    If not already logged in you will be prompted to enter your JIRA/Confluence user ID and password

    Image Removed

    3

    Once logged in click on Comment to leave any further information that was requested by Deirdre or Lorne.

    Remember to alert them, insert @ before their names.

    When finished click on Add.

    Image Removed

    HTML
    <a href="#com-atlassian-confluence">Back to Top</a>

    Chat and share your screen 

    Please be aware the following funtionality may not work with some browsers.

    Icon

    Description

    Image Removed

    At the top of screen, if you see the phone receiver icon, it means you can call the person or persons that you have selected.
    Login to JIRA

    Image Added

    2Click on Issues and then on Search for Issues

    Image Added

    3Click on Type All and scroll down to Vocabulary Issue and select

    Image Added

    4To limit to Group first you need to select the Project Linked Data Ontology

    Image Added

    5Click on More and find Cochrane Review Group on list. Once you have selected this option the system will automatically open up a drop-down list of Group names for you to search.

    Image Added

    6The drop down list will give you a number of suggestions, probably based on previous searches or you can begin to type the name in the search field

    Image Added

    7You also have the option to select a particular status

    Image Added

    Image Removed

    Once on a call you can also share your screen by clicking on the screen symbol.





    HTML
    <a href="#com-atlassian-confluence">Back to Top</a>




    HTML
    <script type="text/javascript">
    AJS.toInit(function(){
    AJS.$('#comments-section').hide();
    });
     for (var i=0; i<nr_li; i++) {
        // if the element has the class fom 'clasa' parameter
        if(tags_li[i].getAttribute('class') == 'innerCell'){
             tags_li[i].style.overflow = 'visible';
                //tags_li[i].style.overflow-y= 'visible';
        }   
      }
    </script>