Skip to content

Commit

Permalink
Merge branch 'master' into update-sbt-1-10-2
Browse files Browse the repository at this point in the history
  • Loading branch information
imsdu authored Sep 16, 2024
2 parents bd02e3f + 9228cd8 commit e1e480f
Show file tree
Hide file tree
Showing 7 changed files with 45 additions and 14 deletions.
1 change: 1 addition & 0 deletions docs/ignore-paths.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ https://github.com/BlueBrain/nexus-js/blob/main/packages/nexus-sdk/README.md
https://github.com/BlueBrain/nexus-js/blob/main/packages/react-nexus/README.md
https://github.com/BlueBrain/nexus-web/blob/main/README.md.*
https://github.com/lightbend/config.*
https://github.com/BlueBrain/nexus/issues?.*
https://www.janelia.org
http://mouselight.janelia.org/
http://ml-neuronbrowser.janelia.org
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/paradox/docs/delta/api/resources-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ That means that when those get updated, the resources importing them must be als

@@@ note { .warning title="Reserved types and fields" }

A generic resource can not have a type belonging to the Nexus vocabulary (https://bluebrain.github.io/nexus/vocabulary/).
A generic resource can not have a type belonging to the Nexus vocabulary `https://bluebrain.github.io/nexus/vocabulary/`.

Moreover it can not include any field starting with underscore (_) at the root level as these fields are reserved for Nexus metadata.
@@@
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/paradox/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Knowledge Graph. You can find out more information on our @link:[product home pa

### Is Blue Brain Nexus free to use?

Yes, Nexus is a free, Open Source platform released under @link:[Apache Licence 2.0](https://opensource.org/license/apache-2-0/){ open=new }
Yes, Nexus is a free, Open Source platform released under @link:[Apache Licence 2.0](https://www.apache.org/licenses/LICENSE-2.0){ open=new }

### How do I run Blue Brain Nexus?

Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/paradox/docs/fusion/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Customize the Nexus codebase appearance by setting environment variables. Defaul

- `LOGO_IMG`: HTTPS URL for the application logo. Recommended: SVG format with transparent background. Ideal size: ~35 px height, max 250 px width. @link:[Click here for an example SVG](https://github.com/BlueBrain/nexus-web/blob/main/src/shared/images/EPFL_BBP_logo.svg){ open=new }.
- `LOGO_LINK`: HTTPS URL redirecting from the logo. Example: <https://www.epfl.ch/en/>
- `LANDING_VIDEO`: HTTPS URL for a landing page video. Requirements: MP4 format, H.264 codec, ~10MB, 1920×1080 resolution. @link:[Click here for an example video](https://github.com/BlueBrain/nexus-web/tree/main/src/videos/BrainRegionsNexusPage.mp4){ open=new }. Ensure that the video's main color is not too bright, as the text on top of it will be white.
- `LANDING_VIDEO`: HTTPS URL for a landing page video. Requirements: MP4 format, H.264 codec, ~10MB, 1920×1080 resolution. @link:[Click here for an example video](https://raw.githubusercontent.com/BlueBrain/nexus-web/main/src/shared/videos/BrainRegionsNexusPage.mp4){ open=new }. Ensure that the video's main color is not too bright, as the text on top of it will be white.
- `LANDING_POSTER_IMG`: HTTPS URL for a loading image on the landing page, displayed while the video loads. @link:[Click here for an example poster image](https://github.com/BlueBrain/nexus-web/blob/main/src/shared/images/BrainRegionsNexusPage.jpg){ open=new }. Please use a PNG or JPG image that matches the size and color of the video. Aim for the image to have the same dimensions as the video. Ensure that the image size is kept under 200 KB to improve loading time and user experience.
- `MAIN_COLOR`: Main background color in hex code. Example color: #062d68

Expand All @@ -64,6 +64,6 @@ Customize the Nexus codebase appearance by setting environment variables. Defaul

#### Additional Options

- `FORGE_LINK`: HTTPS URL for the `Forge templates` button (only if using Nexus Forge). Example: <https://some-url.com>
- `FORGE_LINK`: HTTPS URL for the `Forge templates` button (only if using Nexus Forge). Example: `https://some-url.com`

For a comprehensive list of environment variables, see the @link:[Environment Variables List](https://github.com/BlueBrain/nexus-web/blob/main/README.md#env-variables-list){ open=new }.
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ This setup runs the Nexus ecosystem without an identity provider, and the anonym
#### Administration

To list running services or access logs, please refer to the official Docker
@link:[documentation](https://docs.docker.com/engine/reference/commandline/stack/){ open=new }.
@link:[documentation](https://docs.docker.com/reference/cli/docker/stack/){ open=new }.

#### Stopping Nexus

Expand Down
28 changes: 24 additions & 4 deletions docs/src/main/paradox/docs/releases/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,22 +25,42 @@ The latest stable release is **v1.10.0** released on **18.12.2023**.

### Breaking changes

@@@ note { .warning }

The items listed below are changes that have been made in this release that break compatibility with previous releases.

- The S3 support for files has been completely rewritten
- The default Elasticsearch views now uses a new mapping and settings which improves the ability to search for resources
using the listing endpoints.
- Resolvers/storages/views can't be tagged anymore
- The global SSE endpoint, the SSE endpoints for realms/acls/organizations and the SSE endpoint
to fetch indexing errors have been removed
- Fetch organizations and projects by their uuid is now removed

@@@

### Deprecations

@@@ note { .warning }

The items listed below are announcement of future deprecation, these features will be removed in the next release.

- The global SSE endpoint, the SSE endpoints for realms/acls/organizations and the SSE endpoint
to fetch indexing errors have been removed
- Fetch organizations and projects by their uuid is now removed
- Jira Plugin

@@@

### New features / enhancements

- @ref:[S3 support has been rewritten with new features](../delta/api/files-api.md)
- The projects and the different types of resources can now be undeprecated
- Ability to @ref[enforce usage of schema at Project level](../delta/api/projects-api.md)
- Ability to retrieve the annotated original payload for a @ref:[Schema](../delta/api/schemas-api.md#fetch-original-payload) and a @ref:[Resolver](../delta/api/resolvers-api.md#fetch-original-resource-payload-using-resolvers)
- Ability to add custom metadata upon @ref:[creating](../delta/api/files-api.md#create-using-post) and @ref[updating](../delta/api/files-api.md#update) Files
- Ability to @ref:[fetch a search suite](../delta/api/search-api.md#fetch-a-suite)
- Ability to check if a project has been @ref:[correctly provisioned](../delta/api/supervision-api.md#projects-health) and potentially @ref:[heal](../delta/api/supervision-api.md#project-healing) this process
- The @ref:[Projects](../delta/api/projects-api.md#undeprecate) and the different types of resources (
@ref:[Storages](../delta/api/storages-api.md#undeprecate),
@ref:[ElasticSearch Views](../delta/api/views/elasticsearch-view-api.md#undeprecate), @ref:[Sparql Views](../delta/api/views/sparql-view-api.md#undeprecate), @ref:[Composite Views](../delta/api/views/composite-view-api.md#undeprecate),
@ref:[Schemas](../delta/api/schemas-api.md#undeprecate)) can now be undeprecated
- @ref:[Custom metadata can now be added to files](../delta/api/files-api.md#create-using-post)
- @ref:[Creating point-in-time for Elasticsearch queries](../delta/api/views/elasticsearch-view-api.md#create-a-point-in-time)

Expand Down
20 changes: 15 additions & 5 deletions docs/src/main/paradox/docs/releases/v1.10-release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,7 @@
//TODO adjust the end date

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+created%3A2023-12-18..2024-08-30+){
open=new }
since v1.9.
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+created%3A2023-12-18..2024-08-30+){ open=new } since v1.9.

## Nexus Delta

Expand Down Expand Up @@ -54,7 +51,9 @@ Previously deprecated schemas can now be undeprecated.
Previously deprecated views can now be undeprecated. This is available for all view types.

@ref:[More information (ElasticSearch views)](../delta/api/views/elasticsearch-view-api.md#undeprecate)

@ref:[More information (Sparql views)](../delta/api/views/sparql-view-api.md#undeprecate)

@ref:[More information (Composite views)](../delta/api/views/composite-view-api.md#undeprecate)

### Elasticsearch views
Expand All @@ -78,6 +77,7 @@ It is now possible to add custom metadata when creating and updating files. This
search.

@ref:[More information about metadata during file creation](../delta/api/files-api.md#create-using-post)

@ref:[More information about metadata during file update](../delta/api/files-api.md#update)

### Storages
Expand All @@ -87,6 +87,7 @@ search.
The S3 support for Nexus Delta has been rewritten and new operations are available.

@ref:[More information for storages](../delta/api/storages-api.md)

@ref:[More information for files](../delta/api/files-api.md)

#### Disabling default storage
Expand Down Expand Up @@ -152,5 +153,14 @@ A new endpoint has been added to heal a project.

## Nexus Fusion

TODO
### Support for undeprecation

Undeprecation of Project, Storage, View and Schema was added.

### Misc

Minor bugfixes and improvements were included in this release.

See the @link:[list of addressed issues](https://github.com/BlueBrain/nexus/issues?q=is%3Aissue+is%3Aclosed+created%3A2023-12-18..2024-08-30+label%3Afusion+){
open=new } since v1.9.

0 comments on commit e1e480f

Please sign in to comment.