Merge pull request #338 from GateNLP/v2.0.0

Release for 2.0.0

CHANGELOG.md

@@ -1,9 +1,22 @@
 # Changelog
 
-## [unreleased]
+## [development]
 ### Added
+
+### Fixed
+
+## [2.0.0] 2023-04-13
+### Added
+- Isolate documentation build chain ([#326](https://github.com/GateNLP/gate-teamware/pull/326))
+- Add doi to citation file and doi badge ([#332](https://github.com/GateNLP/gate-teamware/pull/332))
+- Add logging and alter data type for telemetry ([#333](https://github.com/GateNLP/gate-teamware/pull/333))
+- Add more logging when telemetry is switched off and send_telemetry is called ([#337](https://github.com/GateNLP/gate-teamware/pull/337))
+
 ### Changed
+- Update node 12 actions to newer node 16 versions ([#334](https://github.com/GateNLP/gate-teamware/pull/334))
+
 ### Fixed
+- Fix for documentation build breaking ([#336](https://github.com/GateNLP/gate-teamware/pull/336)) 
 
 ## [0.4.0] 2023-04-03
 ### Added

CITATION.cff

@@ -22,6 +22,11 @@ authors:
   given-names: Kalina
   orcid: https://orcid.org/0000-0001-6152-9600
 cff-version: 1.2.0
+identifiers:
+- description: The collection of archived snapshots of all versions of GATE Teamware
+    2
+  type: doi
+  value: 10.5281/zenodo.7821718
 keywords:
 - NLP
 - machine learning
@@ -32,8 +37,4 @@ repository-code: https://github.com/GateNLP/gate-teamware
 title: GATE Teamware
 type: software
 url: https://gatenlp.github.io/gate-teamware/
-version: 0.4.0
-identifiers:
-  - description: The collection of archived snapshots of all versions of GATE Teamware 2
-    type: doi
-    value: "10.5281/zenodo.7821718"
+version: 2.0.0

VERSION

@@ -1 +1 @@
-0.4.0
+2.0.0

docs/docs/.vuepress/versions.json

@@ -10,6 +10,10 @@
    "text": "0.4.0",
    "value": "/gate-teamware/0.4.0/"
   },
+  {
+   "text": "2.0.0",
+   "value": "/gate-teamware/2.0.0/"
+  },
   {
    "text": "development",
    "value": "/gate-teamware/development/"

docs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gate-teamware-docs",
-  "version": "0.4.0",
+  "version": "2.0.0",
   "description": "Documentation for GATE Teamware.",
   "main": "index.js",
   "scripts": {

docs/versioned/0.3.0/.vuepress/versions.json

@@ -10,6 +10,10 @@
    "text": "0.4.0",
    "value": "/gate-teamware/0.4.0/"
   },
+  {
+   "text": "2.0.0",
+   "value": "/gate-teamware/2.0.0/"
+  },
   {
    "text": "development",
    "value": "/gate-teamware/development/"

docs/versioned/0.4.0/.vuepress/versions.json

@@ -10,6 +10,10 @@
    "text": "0.4.0",
    "value": "/gate-teamware/0.4.0/"
   },
+  {
+   "text": "2.0.0",
+   "value": "/gate-teamware/2.0.0/"
+  },
   {
    "text": "development",
    "value": "/gate-teamware/development/"

docs/versioned/2.0.0/.vuepress/components/AnnotationRendererPreview.vue

@@ -0,0 +1,85 @@
+<template>
+  <div>
+    <b-tabs>
+      <b-tab title="Code">
+
+      <slot></slot>
+
+      </b-tab>
+      <b-tab title="Preview">
+        <b-card class="mb-2 mt-2">
+          <AnnotationRenderer :config="config"
+                              :document="document" :allow_document_reject="true"
+                              v-model="annotationOutput"
+                              :doc_preannotation_field="preAnnotation"
+          ></AnnotationRenderer>
+        </b-card>
+        <b-card class="mb-2 mt-2">
+          <p><strong>Annotation output:</strong></p>
+          {{annotationOutput}}
+        </b-card>
+      </b-tab>
+
+    </b-tabs>
+  </div>
+
+</template>
+
+<script>
+import AnnotationRenderer from '@/components/AnnotationRenderer';
+
+export default {
+  name: "AnnotationRendererPreview",
+  components: {
+    AnnotationRenderer
+  },
+  data(){
+    return {
+      annotationOutput: {}
+
+    }
+
+  },
+  props: {
+    preAnnotation: {
+      default(){
+        return ""
+      }
+    },
+    document: {
+      default(){
+        return {text: "Sometext with <strong>html</strong>"}
+      }
+    },
+    config: {
+      default() {
+        return [
+            {
+              "name": "htmldisplay",
+              "type": "html",
+              "text": "{{{text}}}"
+            },
+            {
+              "name": "sentiment",
+              "type": "radio",
+              "title": "Sentiment",
+              "description": "Please select a sentiment of the text above.",
+              "options": {
+                "negative": "Negative",
+                "neutral": "Neutral",
+                "positive": "Positive"
+
+              }
+            }
+          ]
+      }
+    },
+  }
+}
+</script>
+
+<style>
+legend {
+font-weight: bold;
+}
+</style>

docs/versioned/2.0.0/.vuepress/components/DisplayVersion.vue

@@ -0,0 +1,21 @@
+<template>
+<span>{{version_name}}</span>
+</template>
+
+<script>
+import versionData from "../versions.json"
+export default {
+  name: "DisplayVersion",
+  computed: {
+    version_name(){
+      return versionData.current
+    }
+  }
+
+
+}
+</script>
+
+<style scoped>
+
+</style>

docs/versioned/2.0.0/.vuepress/config.js

@@ -0,0 +1,41 @@
+const versionData = require("./versions.json")
+const path = require("path");
+module.exports = context => ({
+    title: 'GATE Teamware Documentation',
+    description: 'Documentation for GATE Teamware',
+    base: versionData.base,
+    themeConfig: {
+        nav: [
+            {text: 'Home', link: '/'},
+            {text: 'Annotators', link: '/annotatorguide/'},
+            {text: 'Managers & Admins', link: '/manageradminguide/'},
+            {text: 'Developer', link: '/developerguide/'}
+        ],
+        sidebar: {
+            '/manageradminguide/': [
+                "",
+                "project_management",
+                "project_config",
+                "documents_annotations_management",
+                "annotators_management"
+            ],
+            '/developerguide/': [
+                '',
+                'testing',
+                'releases',
+                'documentation',
+                "api_docs",
+
+            ],
+        },
+    },
+    configureWebpack: {
+        resolve: {
+            alias: {
+                '@': path.resolve(__dirname, versionData.frontendSource)
+            }
+        }
+    },
+
+
+})

docs/versioned/2.0.0/.vuepress/enhanceApp.js

@@ -0,0 +1,17 @@
+import Vue from 'vue'
+import {BootstrapVue, BootstrapVueIcons, IconsPlugin} from 'bootstrap-vue'
+
+import 'bootstrap/dist/css/bootstrap.css'
+import 'bootstrap-vue/dist/bootstrap-vue.css'
+
+Vue.use(BootstrapVue)
+Vue.use(BootstrapVueIcons)
+
+export default ({
+  Vue, // the version of Vue being used in the VuePress app
+  options, // the options for the root Vue instance
+  router, // the router instance for the app
+  siteData // site metadata
+}) => {
+
+}