This is a patch to make the current instructions for D3.js clearer.

Currently, the Status report (/admin/reports/status) gives this warning if D3.js is not found:

Webprofiler module requires D3.js library to properly render data. See README.md file to learn how to download it.

The webprofiler README.md says:

- d3.js: Webprofiler module requires D3 library 3.x (not 4.x) to render data.
  Download https://github.com/d3/d3 into /libraries/d3/d3.min.js

The compiled library isn't directly available in that repo, and my first inference was you had to clone the whole project, or install an npm package, when in fact all you need to do is download the correct version from the CDN.

So I've rewritten it to say that.

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

wturrell created an issue. See original summary.

wturrell’s picture

Assigned: wturrell » Unassigned
FileSize
740 bytes
lussoluca’s picture

Status: Needs review » Needs work

I think that the correct way to install D3 and Highlight.js is using Composer, so we can rephrase the messages in the status page in that way.

wturrell’s picture

Status: Needs work » Needs review
FileSize
3.06 KB
3.22 KB

OK try this - revised version with:

- modified requirements message for D3 and Highlight.js
- install split into composer/manual methods in README.md
- put the composer.json section descriptions before the code fragments, rather than after, for clarity
- rephrase mention of composer/installers, remind people to check they have an entry for it
- reminder to run 'composer update' at the end

  • lussoluca committed 51caf0b on 8.x-1.x authored by wturrell
    Issue #2860138 by wturrell: Improve instructions for installing D3.js
    
lussoluca’s picture

Status: Needs review » Fixed
Issue tags: +DevDaysSeville

Great!
Committed and pushed to 8.x-1.x
Thanks

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.

shaisamuel’s picture

Version: 8.x-1.x-dev » 8.x-1.0-rc2

--