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
- Cochrane Information Specialists
- Anyone who is working on Linked Data projects
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 channel
- to share files and posts
- we 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:
- Click on + beside Direct Message at the bottom of the lefthand column
- 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
- Enter multiple names if you wish to create a group
- When ready click on GO
Confluence
What do we use Confluence for?
CRG SPace
Annotation Guidance
JIRA
JIRA is used for project and issue tracking for both vocabulary and tool issues, and tool development.
LDD and
LDO
We have two boards LDD and LDO where we can monitor and track progress of all logged issues.
Each CRG has their own Space in Confluence where they can store any documentation related to their annotation work. On the main page of this Space a form has been provide for reporting vocabulary issues.
Information on how to add new pages or edit existing ones in your Space can be found HERE.
Do 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
| Action | Description | |
|---|---|---|
| 1 | Click on Create in the blue menu bar at top of page to create a blank page |
|
| 2 | Click on the 3 dots beside Create to open up a list of templates - use only if you want something other than a blank page | |
| 3 | Select the template you wish to use and click on create |
|
| 4 | When page is completed click on publish |
|
Editing a page
Action | Description | |
|---|---|---|
| 1 | Go to Space home page | |
| 2 | Click on Edit at the top of the screen |
|
| 3 | Before you can structure your page you need to add a title after which the horizontal edit menu bar will be available |
|
| 4 | Vary 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. |
|
| 5 | Insert macros. This is useful if you want to insert table of contents, information boxes etc. |
|
Terms requested using the Report a Vocabulary Issue form
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.
Responding to comments on my JIRA ticket term request
Sometimes 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.
| Action | Image | |
|---|---|---|
| 1 | Click on the JIRA ticket link (title of request) within the email that you receive to your email inbox |
|
| 2 | If not already logged in you will be prompted to enter your JIRA/Confluence user ID and password |
|
| 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. |
|
