Versions Compared

Key

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

Table of Contents
maxLevel2
stylesquare


title
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
Panel
borderColorblack
titleColorblack
Who has access?

Anyone

who is working on Linked Data projects 

working on 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

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

What do we use Confluence for?

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

CRG 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 found 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

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 

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.


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.

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

Expand
titleClick 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
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

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





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. 

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. 

Open Vocabulary Issues page shows progress of JIRA tickets. 

Expand
titleExpland here for explanation of JIRA LDO status
StatusDescriptionDonethe 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 the software developersSolution 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

Excerpt
  • Sometimes more information is required from the requester and this is inserted as a comment on the the JIRA ticket for the specific request
  • An email alert to be sent to the requester which includes a link to the request 
ActionImage1Click 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>
Within JIRA it is possible to search for any requests that you have made. There are a number of limits that you can apply to this search including, your name or your Group name.

My requests (reporter)

Follow the step by step guide in the table below.

Cochrane Group 

Follow the step by step guide in the table below.




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>