Hidden and faulty documentation

Created on 20 May 2024, about 1 month ago
Updated 27 May 2024, about 1 month ago

Problem/Motivation

The documentation contained in the README.md needs updating as errors abound.

Proposed resolution

### jsonview library
The [jsonview library](https://github.com/yesmeck/jquery-jsonview) provides an
improved UI for viewing JSON on the front-end, e.g. on a node page.

"[UNMAINTAINED]" is what you're met with on the above github page. "This repository has been archived by the owner on Jan 18, 2022"

#### Installing jsonview with composer

composer require yesmeck/jquery-jsonview
spawns this error message:

"Could not find a matching version of package yesmeck/jquery-jsonview. Check the package spelling, your version constraint and that the package is available in a stability which matches your minimum-stability (stable)"

#### Installing jsonview without composer

Download the jsonview library from the following URL:

* https://github.com/yesmeck/jquery-jsonview

Place the latest releases into the site's "libraries" directory.

The directory structure should be as follows:

```
- core
- libraries
 \- jsonview

No.
This structure, on the other hand, will make the viewer work:

/libraries/jquery-jsonview/dist/jquery.jsonview.css
/libraries/jquery-jsonview/dist/jquery.jsonview.js

(Btw, you set a Drupal message when the jsoneditor library is not found. You could do the same for the jsonview library - if you will continue to use it, that is)

Remaining tasks

Update the README.md AND put all the installation tips on the module page at drupal.org as well. Hiding crucial installation tips has very few upsides for the end users.

Or, better yet, do as Chi suggests and Add a formatter to represent JSON data in human readable form ✨ Add a formatter to represent JSON data in human readable form Needs work .

(Patching contrib modules in Drupal is a rather tedious work for most of us.)

Or including an improved version of Simple Json Viewer β†’ is the best solution. The maintainer of the Simple Json Viewer module has given up the fight. But there may be useful code in the wreckage.

Or perchance Replace JSONEditor library with svelte-jsoneditor πŸ“Œ Replace JSONEditor library with svelte-jsoneditor Active - even if people looking at that solution seem a bit unpleasantly surprised.

User interface changes

None.

API changes

None.

Data model changes

None.

πŸ› Bug report
Status

Active

Version

1.0

Component

Documentation

Created by

πŸ‡©πŸ‡°Denmark Steven Snedker

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Production build 0.69.0 2024