export plan phases order is not consistent with their order on the web page

StCyr commented 8 months ago

Please complete the following fields as applicable:

What version of the DMPRoadmap code are you running? (e.g. v2.2.0)

v3 (dmponline.be)

Expected behaviour:

Phases in exported plan are ordered in the same way they are sorted on the web page

Actual behaviour:

export plan phases order is not consistent with their order on the web page

Steps to reproduce:

download plan at https://dmponline.be/plans/200312/download in html format for example and confirm the phase order in the exported plan is not the same as the order on the https://dmponline.be/plans/200312 page

nicolasfranck commented 8 months ago

There seem to be several orders defined, and additionally some filtering:

navigation bar lists phases in unspecified order: https://github.com/DMPRoadmap/roadmap/blob/main/app/views/plans/_navigation.html.erb#L1
download page lists phases order by internal number: https://github.com/DMPRoadmap/roadmap/blob/main/app/controllers/plans_controller.rb#L378
base roadmap selects most recently updated phase to download when no phase was selected for download: https://github.com/DMPRoadmap/roadmap/blob/main/app/controllers/plan_exports_controller.rb#L48
our roadmap orders phases by date_updated: https://github.com/DMPbelgium/roadmap/blob/master/config/initializers/ugent.rb#L82

In practice all of these methods should make no difference: the number is assigned automatically on creation, and the phase record itself is never updated.

By additional filtering I mean that in the base roadmap you can only select those phases whose visibility settings allow it (i.e. x percent questions have been answered, not a test plan..): https://github.com/DMPbelgium/roadmap/blob/53018d2fc641a6fc6eb61f624ee1efdde38111dc/app/controllers/plan_exports_controller.rb#L43 In our code, that visibility setting seems to be ignored: https://github.com/DMPbelgium/roadmap/blob/master/config/initializers/ugent.rb#L82

StCyr commented 8 months ago

Well, we have a ticket from a customer (RITM0079728 for reference) and there she says that the order is meaningful:

Naast de pagina met 'Project Details' en 'Plan Overview' hebben we drie in te vullen tabbladen:

  *   HOGENT DMP
  *   HOGENT GDPR
  *   HOGENT DPIA
Deze volgorde heeft ook een inhoudelijke betekenis.

So, I guess we should probably stick to that order, which is not the case today. See for example: https://dmponline.be/plans/200063/download

DMPbelgium / roadmap

export plan phases order is not consistent with their order on the web page #89