Skip to content

Commit

Permalink
Merge pull request #252 from geoblacklight/2024-02-sprint-blog
Browse files Browse the repository at this point in the history
Feb 2024 blog post
  • Loading branch information
karenmajewicz authored Feb 12, 2024
2 parents a43deca + e96420e commit e79ca9e
Show file tree
Hide file tree
Showing 9 changed files with 165 additions and 54 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ This command will install all the necessary modules for the mkdocs platform and

`pip install mkdocs-table-reader-plugin`

`pip install mkdocs-git-revision-date-localized-plugin`



### Edit the website
Expand Down
107 changes: 107 additions & 0 deletions docs/blog/posts/2024-02-12_version-4-2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
---
date: 2024-02-12
authors:
- Karen Majewicz
categories:
- sprints
- releases
---

# Winter 2024 sprint Wrap-up - GeoBlacklight v4.2

## :pushpin: Summary

The GeoBlacklight Community conducted a two-week sprint from January 29 to February 9, 2024, culminating in the release of a [new version of GeoBlacklight](https://github.com/geoblacklight/geoblacklight/releases/tag/v4.2.0). This update not only brings maintenance enhancements but also introduces new viewers for COGs, PMTiles, and IIIF Manifests. Additionally, the community has made substantial improvements to the documentation, making it easier to maintain and more informative for new users.

<!-- more -->

## :fontawesome-solid-glasses: New Viewers in GeoBlacklight

### OpenLayers for viewing modern data formats: COGS and PMTiles

Version 4.2.0 of GeoBlacklight introduces new viewers for two web-based geospatial data formats: Cloud Optimized GeoTIFFs (COGs) and PMTiles. COGs are an extension of the traditional GeoTIFF file format, optimized for cloud storage and web access, while PMTiles offer a method for storing and accessing numerous map tiles in a single, streamlined file. Both formats are designed to improve efficiency and speed across the web by utilizing HTTP range requests. This allows users to request only parts of the data, rather than entire datasets or images, distinguishing these formats from traditional geospatial web services like WFS or ArcGIS REST services. Both of the new viewers use OpenLayers instead of Leaflet, which, up until now, has been the only mapping library for GeoBlacklight.


<div class="grid cards" markdown>

- ![](blog-images/cog-layer.png)

COGs viewer in GeoBlacklight

- ![](blog-images/pmtiles.png)

PMTiles viewer in GeoBlacklight

</div>

### Clover for IIIF Manifests



![](blog-images/clover.png){width=40% align=left}

In earlier versions, GeoBlacklight was limited to displaying single-part images through the IIIF Image APIs, requiring anyone interested in showcasing multipart images via IIIF Manifests to integrate a custom viewer. With the release of Version 4.2, this capability is now included by default with [Clover, a viewer developed by the Samvera community.](https://samvera-labs.github.io/clover-iiif/docs)

<br clear="left"/>

### Baseline support for latest OpenIndexMaps spec v1.0

![](blog-images/index-map-update.png){ width=40% align=left}

The OpenIndexMaps project has released [version 1.0](https://openindexmaps.org/specification/1.0.0), an expanded spec that replaced the [legacy version 0](https://openindexmaps.org/specification/0.0.0). There are minor semantic differences between the specs, and we updated GeoBlacklight to support either version.

<br clear="left"/>


## :construction_site: Maintenance & Framework updates

- Support for Ruby on Rails version 7.1
- Deprecated Faraday
- Implemented [Vite Ruby](https://vite-ruby.netlify.app/), via the [vite-rails](https://vite-ruby.netlify.app/guide/rails.html) Ruby gem

## :notepad_spiral: Documentation Improvements

- Merged the GitHub repositories of the public GeoBlacklight website and the dedicated docs. This will make it easier to maintain over time and makes searching for information from the main site more fruitful.
- Reorganized the navigation categories and added a Reference section for quick look-up charts
- **New or updated pages**
- [For Developers](../../docs/developers.md): Added more details and a diagram for new developers
- [User authentication](../../docs/user_authentication.md): New page about configuring user accounts and logins
- [JSONs and GeoJSONs](../../docs/json-geojson.md): New page clarifying the difference between the file formats
- Redesigned the [Showcase](../../showcase/index.md) grid to include public code repositories.

!!! info "More details"

### [To read more about version 4.2 and how to upgrade, read the release notes on GitHub.](https://github.com/geoblacklight/geoblacklight/releases/tag/v4.2.0) :material-github:

### [To read more about our sprint activities, browse the GitHub project board](https://github.com/orgs/geoblacklight/projects/3/views/1) :octicons-project-24:

## :sunrise_over_mountains: What's on the horizon?

### GeoBlacklight version 5

Our goals for the next major version of GeoBlacklight depend on upgrading our dependencies and frameworks. We made significant progress on modernizing our Javascript library into ES6 modules and removing our jQuery dependency. This progress is currently part of a development branch that we will resume work on at the next sprint.

We also plan to upgrade to Bootstrap v5 and Blacklight v8. [Review our Release Calendar for more details.](../../docs/releases.md)

These framework upgrades will allow us to pursue feature enhancements, such as addressing limitations of the map views or enabling more complex map searches.


### Continuing to support newer data formats

The integration of IIIF Manifests, COGs, and PMTiles into the latest version of GeoBlacklight reflects a growing trend in data sharing, moving away from the conventional of offering discrete, downloadable files and toward a more dynamic model.

### Investigating OpenLayers

We have been using Leaflet since the first version of GeoBlacklight, but begun exploring other mapping libraries, particularly OpenLayers for some features.

### Improving the default interface

After we upgrade our libraries, we will be able to address the recommendations from the [Maps UX Workgroup](https://docs.google.com/document/d/1ZXfTMGVAjzi5-KUIqshkLFmkPTFpH-G6cHbLl1oGw6k/edit).

!!! tip ""

Have a suggestion for a GeoBlacklight Version 5? [Get in touch with the community](../../../../community/#how-to-connect) or [create an issue in our GitHub repository](https://github.com/geoblacklight/geoblacklight/issues).

Thank you to everyone who participated during this sprint! Please consider joining us at the next community sprint coming in Summer 2024. <br>

-Karen
Binary file added docs/blog/posts/blog-images/clover.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/blog/posts/blog-images/cog-layer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/blog/posts/blog-images/index-map-update.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/blog/posts/blog-images/pmtiles.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
52 changes: 52 additions & 0 deletions docs/docs/framework-recommendations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
This page lists the recommended languages and frameworks to use with your installation of GeoBlacklight

### Metadata
* __Aardvark (Recommended)__
* GBL 1.0 (Deprecated)

### Ruby
* __3.2 (Recommended)__
* 2.7 / Support Ends 31 Mar 2023

### Ruby on Rails
* __7.0+ (Recommended)__
* 6.1
* 6.0 / Support Ends June 1, 2023

### Blacklight
* __v7+ (Recommended)__
* v8 / Will be supported in GBL v5+

### Bootstrap
* __v4 (Recommended)__
* v5 / Will be supported in GBL v5+

### ViewComponents
* __GBL v5 (Required)__
* GBL v4 (Recommended)

### Javascript
* __GBL v5 - ES6 / Modern Javascript (Required)__
* GBL v4 / jQuery + ES5 (Recommended)

### Map Library
* __Leaflet (Recommended)__
* TBD / GBL v5+

### Apache Solr
* __v9+ (Recommended)__
* <8.11 versions are End Of Life (EOL)

### Production RDBMS
* __PostgreSQL (Recommended)__
- For potential adopters of GEOMG

### Background Queue
* _Not Required_
* __Sidekiq + Redis (Recommended)__
- For potential adopters of GEOMG
- Potential future GBL enhancement: Background Downloads

### GeoServer
* _Not Required_
* Used by many GeoBlacklight adopters: Harvard, Princeton, Stanford
55 changes: 1 addition & 54 deletions docs/docs/releases.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Releases
# Release Calendar

GeoBlacklight release and technology dependency matrix.

Expand All @@ -19,56 +19,3 @@ GeoBlacklight release and technology dependency matrix.
| [Background Queue](https://guides.rubyonrails.org/active_job_basics.html) | N/A | N/A | [Sidekiq](https://sidekiq.org/) + [Redis](https://redis.io/) |
| [GeoServer](https://geoserver.org/) | Optional | Optional | Optional |

## Recommendations

### Metadata
* __Aardvark (Recommended)__
* GBL 1.0 (Deprecated)

### Ruby
* __3.2 (Recommended)__
* 2.7 / Support Ends 31 Mar 2023

### Ruby on Rails
* __7.0+ (Recommended)__
* 6.1
* 6.0 / Support Ends June 1, 2023

### Blacklight
* __v7+ (Recommended)__
* v8 / Will be supported in GBL v5+

### Bootstrap
* __v4 (Recommended)__
* v5 / Will be supported in GBL v5+

### ViewComponents
* __GBL v5 (Required)__
* GBL v4 (Recommended)

### Javascript
* __GBL v5 - ES6 / Modern Javascript (Required)__
* GBL v4 / jQuery + ES5 (Recommended)

### Map Library
* __Leaflet (Recommended)__
* TBD / GBL v5+

### Apache Solr
* __v9+ (Recommended)__
* <8.11 versions are End Of Life (EOL)

### Production RDBMS
* __PostgreSQL (Recommended)__
- For potential adopters of GEOMG

### Background Queue
* _Not Required_
* __Sidekiq + Redis (Recommended)__
- For potential adopters of GEOMG
- Potential future GBL enhancement: Background Downloads

### GeoServer
* _Not Required_
* Used by many GeoBlacklight adopters: Harvard, Princeton, Stanford

3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ markdown_extensions:
plugins:
- search
- table-reader
- git-revision-date-localized
- blog:
blog_dir: blog
# blog_toc: true
Expand All @@ -69,6 +70,7 @@ plugins:
post_slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower


extra:
social:
Expand Down Expand Up @@ -96,6 +98,7 @@ nav:
- Running in Production:
- 'Hardware Recommendations': 'docs/hardware_recommendations.md'
- 'Implementation Recommendations': 'docs/implementation_recommendations.md'
- 'Framework Recommendations': 'docs/framework-recommendations.md'
- 'User Authentication': 'docs/user_authentication.md'
- 'Using an External Solr Instance': 'docs/external_solr.md'
- 'Periodic Maintenance': 'docs/periodic_maintenance.md'
Expand Down

0 comments on commit e79ca9e

Please sign in to comment.