From 0d37d43d9db3023bdcc1ffb6a8b35bfada49a28d Mon Sep 17 00:00:00 2001 From: Nick Wells Date: Thu, 5 May 2022 15:26:06 +0200 Subject: [PATCH] Release notes and minor doc updates (#3189) Co-authored-by: Bogdan Roman --- docs/src/main/paradox/docs/fusion/admin.md | 8 +++--- docs/src/main/paradox/docs/fusion/plugins.md | 4 +-- docs/src/main/paradox/docs/fusion/search.md | 2 +- docs/src/main/paradox/docs/fusion/studio.md | 11 ++++---- .../docs/releases/v1.7-release-notes.md | 25 ++++++++++--------- 5 files changed, 26 insertions(+), 24 deletions(-) diff --git a/docs/src/main/paradox/docs/fusion/admin.md b/docs/src/main/paradox/docs/fusion/admin.md index 1a9c08bb51..7fc014c5c3 100644 --- a/docs/src/main/paradox/docs/fusion/admin.md +++ b/docs/src/main/paradox/docs/fusion/admin.md @@ -66,11 +66,11 @@ status of your project. Navigate to the project where you want to create a resource. Click on the “Create Resource” button in the right sidebar. Build the JSON payload with the help of the interactive editor, then hit “Save”. -## Resource View +## Resource Panel -In resource view, you can see various visual representations of a Nexus Resource. Based on the resource type, you will -see a set of plugins, each displayed on its own expandable section. By default, there will only be an admin plugin. -You can read more about admin plugin @ref:[here](plugins.md#default-plugins). +The resource panel displays data about an individual resource. Standard resource data is displayed at the top of the resource panel. Based on the resource type, you will +also see a set of plugins, each displayed in its own expandable section. By default, there will only be an admin plugin. +You can read more about the admin plugin @ref:[here](plugins.md#default-plugins). ## Resource Descriptions diff --git a/docs/src/main/paradox/docs/fusion/plugins.md b/docs/src/main/paradox/docs/fusion/plugins.md index 98260c184d..79d92dd917 100644 --- a/docs/src/main/paradox/docs/fusion/plugins.md +++ b/docs/src/main/paradox/docs/fusion/plugins.md @@ -1,5 +1,5 @@ # Plugins -A resource returned by the Nexus Delta API is usually a JSON-LD document. By default Nexus Fusion displays JSON-LD in a +A resource returned by the Nexus Delta API is usually a JSON-LD document. By default, Nexus Fusion displays JSON-LD in a code editor. If the user has edit access to the document, they can update the resource in the editor. Resources can represent a wide variety of scientific artifacts. It can be a neuron morphology, neuron electrophysiology, @@ -67,7 +67,7 @@ Plugins should follow this folder naming convention: ## Plugin Manifest -The plugin manifest should be available at the same remote endpoint as the plugins. This is so Nexus Fusion can find +The plugin manifest should be available at the same remote endpoint as the plugins, this is so that Nexus Fusion can find the plugins and apply them dynamically. The plugin manifest is a JSON object with keys that correspond to the plugin name with a value that corresponds to a diff --git a/docs/src/main/paradox/docs/fusion/search.md b/docs/src/main/paradox/docs/fusion/search.md index b214c9db62..574b6a6db8 100644 --- a/docs/src/main/paradox/docs/fusion/search.md +++ b/docs/src/main/paradox/docs/fusion/search.md @@ -136,6 +136,6 @@ All customisations to the search results can be removed using the `Reset` option A search configuration is a predefined, named combination of columns, sort options and filters. You can find these configurations in the Search Config dropdown on the left top of the table. Choosing a search config from the dropdown -will apply the combination of that config to the search table. +will apply the config to the search table. ![Search Configurations](assets/fusion-search-searchconfig-options.png) diff --git a/docs/src/main/paradox/docs/fusion/studio.md b/docs/src/main/paradox/docs/fusion/studio.md index 83ea85052f..aa9e217f95 100644 --- a/docs/src/main/paradox/docs/fusion/studio.md +++ b/docs/src/main/paradox/docs/fusion/studio.md @@ -232,11 +232,12 @@ You can remove a `Workspace` by deprecating it from the `Resource View`. Inside any `Studio View`, under a selected `Workspace`, click the `Add Dashboard` button. -Fill in a form providing the following: +Fill in the Create Dashboard form providing the following: -- `Label`: the name of your new `Dashboard` (required field) +- `Name`: the name of your new `Dashboard` (required field) - `Description`: an optional description for your `Dashboard` -- `Sparql Query`: a valid @link:[SPARQL](https://www.w3.org/TR/rdf-sparql-query/){ open=new } query that conforms to the `dataQuery` field in the configuration. +- `View`: specify the *view* in the project that the dashboard should use as its data source. The view can be of any of the supported Nexus view types including be Sparql, ElasticSearch, and CompositeView. When specifying a composite view, you will also specify whether to query all projections or a specific projection. +- `Query`: a valid query must also be specified: a SPARQL query for SPARQL views (a @link:[SPARQL](https://www.w3.org/TR/rdf-sparql-query/){ open=new } query that conforms to the `dataQuery` field in the configuration) or an ElasticSearch query for ElasticSearch views. #### Sparql Dashboards @@ -255,9 +256,9 @@ You can now also add this `Dashboard` to other `Workspaces` across the project. #### Elasticsearch Dashboard -In the create dashboard form, you can select a elastic search view from the view dropdown. And then use an elastic search +In the create dashboard form, you can select a ElasticSearch view from the view dropdown. And then use an ElasticSearch query targeting that view to populate your dashboard. -It will work same as the sparql dashboard, except for the query and the view. +It will work same as the SPARQL dashboard, except for the query and the view. #### Updating a Dashboard diff --git a/docs/src/main/paradox/docs/releases/v1.7-release-notes.md b/docs/src/main/paradox/docs/releases/v1.7-release-notes.md index 6502e37311..eccdcdcc0b 100644 --- a/docs/src/main/paradox/docs/releases/v1.7-release-notes.md +++ b/docs/src/main/paradox/docs/releases/v1.7-release-notes.md @@ -1,7 +1,7 @@ # v1.7 Release Notes > This is an incremental software release that adds several improvements across the board. The API is backwards -> compatible to v1.6. +> compatible with v1.6. For the detailed list of updates in this release, see the @link:[list of addressed issues](https://github.com/BlueBrain/nexus/issues?q=is%3Aissue+is%3Aclosed+closed%3A2021-10-14..2022-03-14+){ open=new } @@ -15,8 +15,8 @@ visit the @ref:[migration instructions](v1.6-to-v1.7-migration.md) for the neces ![Banner](../assets/v1.7.x/BBP_Nexus-v1.7-Banner.jpg) As you grow your Knowledge Graph every day, it is becoming more and more challenging to find relevant data to fuel your -data driven activities. In October 2021, We introduced a powerful new feature: Global Search. It allows you to make all -Nexus Projects searchable and the data within discoverable. We have received a lot of feedbacks and recently focused on +data driven activities. In October 2021, we introduced a powerful new feature: *Global Search*. It allows you to make all +Nexus Projects searchable and the data within discoverable. We have received a lot of feedback and recently focused on improving further its usability. We are delighted to announce the public release of Nexus 1.7 and here are the highlights. ### Preconfigured Searches @@ -29,8 +29,8 @@ More can be added and relevant columns preselected. ### Specialised Filters We now support filtering for additional columns types. -With the new Numeric column support, you can plot an overview of your selection and easily narrow it down to what is -really useful to you. Similarly, you can now filter using Date columns. +With the new *Numeric* column support, you can plot an overview of your selection and easily narrow it down to what is +really useful to you. Similarly, you can now filter using *Date* columns. ![Numerical Filter](../assets/v1.7.x/2a.numerical-filter-small.png) @@ -39,14 +39,15 @@ really useful to you. Similarly, you can now filter using Date columns. ### Resource Panel When clicking on search results, you can view more details. -The resource panel was improved to highlight important information and actions at the top. -Plugins are continuously improved using your feedbacks. +The @ref:[resource panel](../fusion/admin.md#resource-panel) +was improved to highlight important information and actions at the top. +Plugins are continuously improved using your feedback. ![Banner](../assets/v1.7.x/3.resource-panel.png) ### Search Bar -The search bar now allows you to find and open Studios or Projects from anywhere in Fusion. +The search bar now allows you to find and open *Studios* or *Projects* from anywhere in Fusion. ![Banner](../assets/v1.7.x/4.search-bar.png) @@ -79,9 +80,9 @@ A @link:[series of bugs](https://github.com/BlueBrain/nexus/issues?page=1&q=is%3 ### Elasticsearch pipes With 1.7, Elasticsearch views now rely on pipes to filter and transform data before indexing. -This feature was primarily motivated by user requests of our partners at SWITCH, [some usage examples are detailed here](https://github.com/BlueBrain/nexus/issues/2549). +This feature was primarily motivated by user requests of our partners at SWITCH, [some usage examples of Elasticsearch pipes are detailed here](https://github.com/BlueBrain/nexus/issues/2549). -More details @ref:[here](../delta/api/views/elasticsearch-view-api.md) +@ref:[Read More about Elasticsearch pipes](../delta/api/views/elasticsearch-view-api.md) This change implies a @ref:[migration when updating Nexus Delta to 1.7](v1.6-to-v1.7-migration.md). @@ -89,7 +90,7 @@ This change implies a @ref:[migration when updating Nexus Delta to 1.7](v1.6-to- Besides JVM properties and environment variables, Delta configuration can now be defined via a external file. -More details @ref:[here](../getting-started/running-nexus/configuration/index.md) +@ref:[Read More about Delta configuration](../getting-started/running-nexus/configuration/index.md) ### Deleting tags on resources @@ -120,7 +121,7 @@ Tools will be provided to enable migration from Cassandra to PostgreSQL for exis ## Nexus Fusion -### Graph Analytics +### Graph Analytics Plugin Fusion now enables users to inspect properties and relationships of resources in a given project via the new Graph Analytics plugin. ### Studios Elasticsearch Support