Uploaded image for project: 'eZ Publish / Platform'
  1. eZ Publish / Platform
  2. EZP-27083

Errors in "Extending PlatformUI with new navigation" tutorial

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Medium Medium
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: n/a
    • Component/s: Documentation
    • Labels:
      None

      Description

      There are few errors in the fourth tutorial in the documentation (https://doc.ez.no/display/DEVELOPER/Extending+PlatformUI+with+new+navigation).

      Tutorial 4, step 3:
      Missing the line:

      service: Y.eZ.DashboardBlocksViewService,
      

      in the last code fragment, inside app.route. Without it the dashboard elements are not loading correctly and console is throwing an error when accessing the dashboard from the /ezconf/list URL.

      Tutorial 4, step 6.2:
      There is no information that configuration in file yui.yml should be changed to:

      ezconf-listviewservice:
          requires: ['ez-serversideviewservice']
          path: %extending_platformui.public_dir%/js/views/services/ezconf-listviewservice.js
      

      which means changing the "requires" parameter. Without that change lists is not showing correctly and the console is throwing an error.

      Tutorial 4, step 6.2, fixing the link issue:
      Code fragment where we are throwing an event should look like this:

      this.fire('navigateTo', {
          route: {
              name: link.getData('route-name'),
              params: {
                  id: link.getData('route-id'),
                  languageCode: link.getData('route-languagecode'),
              }
          }
      });
      

      This way we don't need to subscribe this event in the "ezconf-listviewservice.js" (we could just skip this part of the tutorial) and it still will be working as expected.
      Without that change after clicking any link from the list we don't move to any location and the console is throwing an error.

      Tutorial 4, step 7:
      Analogical to previous fix. Correct code to throw an event:

      this.fire('navigateTo', {
          route: {
              name: 'eZConfListOffset',
              params: {
                  offset: offset,
              }
          }
      });
      

      tutorial 4, step 8:
      Analogical to previous fix. Correct code to throw an event:

      this.fire('navigateTo', {
          route: {
              name: 'eZConfListOffsetTypeIdentifier',
              params: {
                  offset: "0", // offset: 0 does not work, because of a bug in PlatformUI
                  typeIdentifier: select.get('value'),
              }
          }
      });
      

        Activity

        Jacek Foremski (Inactive) created issue -
        Dominika Kurek made changes -
        Field Original Value New Value
        Assignee Dominika Kurek [ dominika.kurek@ez.no ]
        Dominika Kurek made changes -
        Status Open [ 1 ] Confirmed [ 10037 ]
        Dominika Kurek made changes -
        Status Confirmed [ 10037 ] Backlog [ 10000 ]
        Dominika Kurek made changes -
        Status Backlog [ 10000 ] Documentation [ 10010 ]
        Dominika Kurek made changes -
        Status Documentation [ 10010 ] Documentation Review [ 10039 ]
        Dominika Kurek made changes -
        Assignee Dominika Kurek [ dominika.kurek@ez.no ]
        MichaƂ Maciej Kusztelak (Inactive) made changes -
        Status Documentation Review [ 10039 ] Documentation Review done [ 10011 ]
        Rui Silva (Inactive) made changes -
        Status Documentation Review done [ 10011 ] QA [ 10008 ]
        Rui Silva (Inactive) made changes -
        Flagged Impediment [ 10000 ]
        Alex Schuster made changes -
        Workflow EZ* Development Workflow [ 103062 ] EZEE Development Workflow [ 108223 ]
        Paulo Nunes (Inactive) made changes -
        Status QA [ 10008 ] Development Review done [ 10028 ]
        Assignee Rui Silva [ rui.silva@ez.no ]
        Paulo Nunes (Inactive) made changes -
        Status Development Review done [ 10028 ] Documentation Review done [ 10011 ]
        Paulo Nunes (Inactive) made changes -
        Flagged Impediment [ 10000 ]
        Dominika Kurek made changes -
        Status Documentation Review done [ 10011 ] Closed [ 6 ]
        Fix Version/s n/a [ 14929 ]
        Resolution Done [ 9 ]

          People

          • Assignee:
            Unassigned
            Reporter:
            Jacek Foremski (Inactive)
          • Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: