Skip to content

Latest commit

 

History

History
197 lines (138 loc) · 32.8 KB

README.md

File metadata and controls

197 lines (138 loc) · 32.8 KB
Raw

volto-eea-kitkat 🍫

Releases

Pipeline Lines of Code Coverage Bugs Duplicated Lines (%)

Pipeline Lines of Code Coverage Bugs Duplicated Lines (%)

Volto Add-ons bundle - A known good set of Volto addons to be used within all EEA projects and beyond.

The eea.kitkat Plone add-on is the backend support for volto-eea-kitkat.

Included Volto Add-ons

  1. Releases Pipeline Pipeline @eeacms/volto-chatbot
  2. Releases Pipeline Pipeline @eeacms/volto-anchors
  3. Releases Pipeline Pipeline @eeacms/volto-matomo
  4. Releases Pipeline Pipeline @eeacms/volto-sentry-rancher-config
  5. Releases Pipeline Pipeline @eeacms/volto-controlpanel
  6. Releases Pipeline Pipeline @eeacms/volto-corsproxy
  7. Releases Pipeline Pipeline @eeacms/volto-taxonomy
  8. Releases Pipeline Pipeline @eeacms/volto-object-widget
  9. Releases Pipeline Pipeline @eeacms/volto-widget-theme-picker
  10. Releases Pipeline Pipeline @eeacms/volto-widget-toggle
  11. Releases Pipeline Pipeline @eeacms/volto-widget-temporal-coverage
  12. Releases Pipeline Pipeline @eeacms/volto-widget-geolocation
  13. Releases Pipeline Pipeline @eeacms/volto-slate-metadata-mentions
  14. Releases Pipeline Pipeline @eeacms/volto-slate-footnote
  15. Releases Pipeline Pipeline @eeacms/volto-slate-zotero
  16. Releases Pipeline Pipeline @eeacms/volto-accordion-block
  17. Releases Pipeline Pipeline @eeacms/volto-block-divider
  18. Releases Pipeline Pipeline @eeacms/volto-listing-block
  19. Releases Pipeline Pipeline @eeacms/volto-metadata-block
  20. Releases Pipeline Pipeline @eeacms/volto-group-block
  21. Releases Pipeline Pipeline @eeacms/volto-columns-block
  22. Releases Pipeline Pipeline @eeacms/volto-tabs-block
  23. Releases Pipeline Pipeline @eeacms/volto-block-image-cards
  24. Releases Pipeline Pipeline @eeacms/volto-nextcloud-video-block
  25. Releases Pipeline Pipeline @eeacms/volto-banner
  26. Releases Pipeline Pipeline @eeacms/volto-resize-helper
  27. Releases Pipeline Pipeline @eeacms/volto-block-style
  28. Releases Pipeline Pipeline @eeacms/volto-widget-dataprovenance
  29. Releases Pipeline Pipeline @eeacms/volto-slate-label
  30. Releases Pipeline Pipeline @eeacms/volto-call-to-action-block
  31. Releases Pipeline Pipeline @eeacms/volto-description-block
  32. Releases Pipeline Pipeline @eeacms/volto-hero-block
  33. Releases Pipeline Pipeline @eeacms/volto-quote-block
  34. Releases Pipeline Pipeline @eeacms/volto-statistic-block
  35. Releases Pipeline Pipeline @eeacms/volto-tags-block
  36. Releases Pipeline Pipeline @eeacms/volto-timeline-block
  37. Releases Pipeline Pipeline @eeacms/volto-toolbar-actions
  38. Releases Pipeline Pipeline @eeacms/volto-block-data-table
  39. Releases @plone-collective/volto-sentry

Upgrade

Upgrading to 25.x

This version adds support for Volto 17 and it is meant to be used with Volto 17+. It may work with Volto 16 but it is not fully backward compatible (especially in Teaser block, anchors, listing), thus upgrading volto-eea-kitkat to version 25+ implies also upgrading to Volto 17+.

Add-ons removed

  1. @kitconcept/volto-blocks-grid

Add-ons added

  1. @eeacms/volto-block-toc

Upgrading to 20.x

This versions comes with @eeacms/volto-tabs-block 17.x. See this package upgrade guide

Upgrading to 10.x

This version requires: @plone/volto >= 16.0.0.alpha.45 (Sentry removed from Volto Core).

New add-ons added

  1. @plone-collective/volto-sentry
  2. @kitconcept/volto-blocks-grid
  3. @eeacms/volto-slate-label
  4. @eeacms/volto-call-to-action-block
  5. @eeacms/volto-description-block
  6. @eeacms/volto-hero-block
  7. @eeacms/volto-quote-block
  8. @eeacms/volto-statistic-block
  9. @eeacms/volto-tags-block
  10. @eeacms/volto-timeline-block

Upgrading to 9.x

This version requires: @plone/volto >= 16.0.0.alpha.15 (volto-slate part of Volto Core).

Dropped dependencies (moved to Volto Core)

  1. volto-slate
  2. volto-block-toc

Resolutions

Volto EEA KitKat provides a set of generic Volto Add-ons and a Known Good Set of these add-ons versions to be used within your Volto projects without having to worry about which add-on version works best with another add-on.

While in other systems when you pin a package version to a specific number you will get that package version, in Javascript world is not that simple.

For this, Volto EEA Kitkat is using selective dependency resolutions. While this work as expected in most of the cases, you may still have some surprises.

Troubleshooting

  1. Make sure your Volto project yarn.lock is not polluted. You can always reset your Volto project yarn.lock with:

     $ npm install -g @plone/generator-volto
 $ cd my-volto-project
 $ yo @plone/volto --skip-install --no-interactive /tmp/new-volto-project
 $ cp /tmp/new-volto-project/yarn.lock .
 $ yarn

  2. Add-on resolutions don't work with workspaces (development mode), thus you'll need to define resolutions within Volto project. To tackle this issue, this Docker image automatically extracts resolutions from add-on and add them also to the Volto project before running tests.

Getting started

Try volto-eea-kitkat with Docker

  git clone https://github.com/eea/volto-eea-kitkat.git
  cd volto-eea-kitkat
  make
  make start

Go to http://localhost:3000

Add volto-eea-kitkat to your Volto project

  1. Make sure you have a Plone backend up-and-running at http://localhost:8080/Plone

    docker compose up backend

  2. Start Volto frontend

  • If you already have a volto project, just update package.json:

    "addons": [
    "@eeacms/volto-eea-kitkat"
],

"dependencies": {
    "@eeacms/volto-eea-kitkat": "*"
}

  • If not, create one:

    npm install -g yo @plone/generator-volto
yo @plone/volto my-volto-project --canary --addon @eeacms/volto-eea-kitkat
cd my-volto-project

  1. Install new add-ons and restart Volto:

    yarn
yarn start

  2. Go to http://localhost:3000

  3. Happy editing!

Release

See RELEASE.md.

How to contribute

See DEVELOP.md.

Copyright and license

The Initial Owner of the Original Code is European Environment Agency (EEA). All Rights Reserved.

See LICENSE.md for details.

Funding

European Environment Agency (EU)