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

As a developer I want to define the SiteAccess name

    Details

    • Story Points:
      1

      Description

      Context:

      In order to simplify the interface and create a better editorial experience, we would like to "hide" the SiteAccess code. This value does not make sense for the end user. It will be better to display the name of the website (human readable).
      Interfaces where this can apply:

      • Page builder (SiteAccess switcher in the top navigation)
      • Content Preview (SiteAccess switcher in the dropdown menu)
      • Page creation modal window (when coming from Content Structure)

      Technical

      It was decided that we would keep using the translation system, as was done for field definition groups and custom tags.
      The domain is called `ezplatform_siteaccess`, and the siteaccess name is used as the key.

      In app/Resources/translations/ezplatform_siteaccess.yml:

      fr: Tatestfull Planet France
      en: Tastefull Planet
      

        Issue Links

          Activity

          Sylvain Guittard created issue -
          Sylvain Guittard made changes -
          Field Original Value New Value
          Rank Ranked higher
          Sylvain Guittard made changes -
          Status Backlog [ 10000 ] Specification [ 10002 ]
          Assignee Sylvain Guittard [ sylvain.guittard@ez.no ]
          Hide
          Sylvain Guittard added a comment -
          Show
          Sylvain Guittard added a comment - ping Bertrand Dunogier Andrzej Longosz
          Hide
          Andrzej Longosz added a comment -

          From my POV translatable option makes more sense. I'm assuming fr and en are SiteAccess names, right?

          Technically it could be a file app/Resources/translations/siteaccess.en.yml where en is current locale.
          Translation key / value could be:
          ezplatform.siteaccess.en.label: 'Tasteful Planet'
          ezplatform.siteaccess.fr.label: 'Tasteful Planet France'
          where en and fr are SiteAccess names respectively.

          Side note: I haven't found any Yaml translation files after all, so I wouldn't recommend breaking convention, let's stick to xliff (though personally I prefer Yaml).

          The second option is of course also doable and probably requires less time.

          Show
          Andrzej Longosz added a comment - From my POV translatable option makes more sense. I'm assuming fr and en are SiteAccess names, right? Technically it could be a file app/Resources/translations/siteaccess.en.yml where en is current locale. Translation key / value could be: ezplatform.siteaccess.en.label: 'Tasteful Planet' ezplatform.siteaccess.fr.label: 'Tasteful Planet France' where en and fr are SiteAccess names respectively. Side note: I haven't found any Yaml translation files after all, so I wouldn't recommend breaking convention, let's stick to xliff (though personally I prefer Yaml). The second option is of course also doable and probably requires less time.
          Hide
          Adam Wójs added a comment -

          +1 for the second option

          Show
          Adam Wójs added a comment - +1 for the second option
          Hide
          Steve Konrad added a comment -

          would also prefer the second option as it could be that there is no main language and the names are required to be translated depending on the language of the currently active siteaccess.

          Show
          Steve Konrad added a comment - would also prefer the second option as it could be that there is no main language and the names are required to be translated depending on the language of the currently active siteaccess.
          Hide
          Sylvain Guittard added a comment -

          Steve Konrad: not sure to understand the use case. Could you please provide more details or give an example of configuration? Thanks.

          Show
          Sylvain Guittard added a comment - Steve Konrad : not sure to understand the use case. Could you please provide more details or give an example of configuration? Thanks.
          Hide
          Steve Konrad added a comment -

          Hi Sylvain, I missread the "second option" to be the suggestion made by Andrzej.

          So using translation to generate the displayed name of the siteaccess might be the best solution. Either of the options mentioned in the tickets description would work as a fallback of sorts (if the translation is missing). In this case I'd prefer the first option as it is closer to the configuration of the siteaccess itself.

          In my opinion the names (most of the time including language and/or country) should be readable by all editors and thus are required to be translatable. Just thinking of the different characters some languages use (cyrillic, roman, etc.).

          Show
          Steve Konrad added a comment - Hi Sylvain, I missread the "second option" to be the suggestion made by Andrzej. So using translation to generate the displayed name of the siteaccess might be the best solution. Either of the options mentioned in the tickets description would work as a fallback of sorts (if the translation is missing). In this case I'd prefer the first option as it is closer to the configuration of the siteaccess itself. In my opinion the names (most of the time including language and/or country) should be readable by all editors and thus are required to be translatable. Just thinking of the different characters some languages use (cyrillic, roman, etc.).
          Hide
          Sylvain Guittard added a comment -

          Regarding the votes on https://discuss.ezplatform.com/t/should-siteaccess-names-be-translatable-or-not, we will add the translation on the SiteAccess names.
          Suggestion from Edi Modrić (displaying SiteAccess names and SiteAccess code) is a very good. Example: Croatian frontend (front_site_cro_2017). This solution covers Editors and Developers needs.

          Bertrand Dunogier: Could you please take care of the technical part? Thanks

          Show
          Sylvain Guittard added a comment - Regarding the votes on https://discuss.ezplatform.com/t/should-siteaccess-names-be-translatable-or-not , we will add the translation on the SiteAccess names. Suggestion from Edi Modrić (displaying SiteAccess names and SiteAccess code) is a very good. Example: Croatian frontend (front_site_cro_2017) . This solution covers Editors and Developers needs. Bertrand Dunogier : Could you please take care of the technical part? Thanks
          Sylvain Guittard made changes -
          Remote Link This issue links to "Specifications (Web Link)" [ 18037 ]
          Sylvain Guittard made changes -
          Status Specification [ 10002 ] Specification Review [ 10038 ]
          Bertrand Dunogier made changes -
          Description h2. Context:
          In order to simplify the interface and create a better editorial experience, we would like to "hide" the SiteAccess code. This value does not make sense for the end user. It will be better to display the name of the website (human readable).
          Interfaces where this can apply:
          - Page builder (SiteAccess switcher in the top navigation)
          - Content Preview (SiteAccess switcher in the dropdown menu)
          - Page creation modal window (when coming from Content Structure)

          h2. Technical

          h3. First option (SiteAccess name is not translatable)
          In app/config/ezplatform.yml:
          {code}
          system:
              fr:
                  name: Tastefull Planet France
                  languages: fr
          {code}

          h3. Second option (SiteAccess name has to be translatable)
          In app/Resources/translations/siteaccess.yml
          {code}
          fr: Tatestfull Planet France
          en: Tastefull Planet
          {code}
          Note: Same approach used on custom tags.
          h2. Context:
          In order to simplify the interface and create a better editorial experience, we would like to "hide" the SiteAccess code. This value does not make sense for the end user. It will be better to display the name of the website (human readable).
          Interfaces where this can apply:
          - Page builder (SiteAccess switcher in the top navigation)
          - Content Preview (SiteAccess switcher in the dropdown menu)
          - Page creation modal window (when coming from Content Structure)

          h2. Technical
          It was decided that we would keep using the translation system, as was done for field definition groups and custom tags.
          The domain is called `ezplatform_siteaccess`, and the siteaccess name is used as the key.

          In {{app/Resources/translations/ezplatform_siteaccess.yml}}:
          {code}
          fr: Tatestfull Planet France
          en: Tastefull Planet
          {code}
          Hide
          Bertrand Dunogier added a comment -

          I have updated the description in regards to the implementation aspects.

          Show
          Bertrand Dunogier added a comment - I have updated the description in regards to the implementation aspects.
          Anonymous made changes -
          Status Specification Review [ 10038 ] Specification Done [ 10003 ]
          Bertrand Dunogier made changes -
          Sprint [2.1] Sprint 5 [ 99 ]
          Bertrand Dunogier made changes -
          Rank Ranked lower
          Bertrand Dunogier made changes -
          Link This issue relates to EZEE-372 [ EZEE-372 ]
          Roland Benedetti made changes -
          Component/s Landing Page Manager [ 14065 ]
          Bertrand Dunogier made changes -
          Story Points 5
          Sylvain Guittard made changes -
          Sprint [2.1] Sprint 5 [ 99 ] [2.2] Sprint 1 [ 101 ]
          Sylvain Guittard made changes -
          Rank Ranked lower
          Sylvain Guittard made changes -
          Sprint [2.2] Sprint 1 [ 101 ] [2.2] Sprint 2 [ 102 ]
          Sylvain Guittard made changes -
          Rank Ranked lower
          Dawid Parafiński made changes -
          Assignee Sylvain Guittard [ sylvain.guittard@ez.no ] Dawid Parafiński [ david.parafinski@ez.no ]
          Dawid Parafiński made changes -
          Assignee Dawid Parafiński [ david.parafinski@ez.no ] Sylvain Guittard [ sylvain.guittard@ez.no ]
          Dawid Parafiński made changes -
          Assignee Sylvain Guittard [ sylvain.guittard@ez.no ] Dawid Parafiński [ david.parafinski@ez.no ]
          Dawid Parafiński made changes -
          Status Specification Done [ 10003 ] Development [ 3 ]
          Sylvain Guittard made changes -
          Story Points 5 1
          Sylvain Guittard made changes -
          Sprint [2.2] Sprint 2 [ 102 ]
          Sylvain Guittard made changes -
          Rank Ranked higher
          Dawid Parafiński made changes -
          Status Development [ 3 ] Development Done [ 5 ]
          Show
          Dawid Parafiński added a comment - https://github.com/ezsystems/ezplatform-admin-ui/pull/449
          Dawid Parafiński made changes -
          Status Development Done [ 5 ] Documentation [ 10010 ]
          Dawid Parafiński made changes -
          Assignee Dawid Parafiński [ david.parafinski@ez.no ]
          Hide
          Dawid Parafiński added a comment -
          Show
          Dawid Parafiński added a comment - This needs doc, Sylvain Guittard Dominika Kurek
          Magdalena Zuba made changes -
          Assignee Magdalena Zuba [ magdalena.zuba@ez.no ]
          Show
          Magdalena Zuba added a comment - doc PR: https://github.com/ezsystems/developer-documentation/pull/291
          Magdalena Zuba made changes -
          Status Documentation [ 10010 ] Documentation Done [ 10040 ]
          Assignee Magdalena Zuba [ magdalena.zuba@ez.no ]
          Show
          Barbara Grajczyk added a comment - PR merged: https://github.com/ezsystems/ezplatform-admin-ui/commit/2ab2aa1888b0259f289ebc8a24f76c8bbfa5591a
          Barbara Grajczyk made changes -
          Status Documentation Done [ 10040 ] Closed [ 6 ]
          Resolution Done [ 9 ]
          Transition Time In Source Status Execution Times Last Executer Last Execution Date
          Backlog Backlog Specification Specification
          16s 1 Sylvain Guittard 02/Feb/18 6:03 PM
          Specification Specification Specification Review Specification Review
          17d 4h 35m 1 Sylvain Guittard 19/Feb/18 10:39 PM
          Specification Review Specification Review Specification Done Specification Done
          9d 18h 1 01/Mar/18 4:40 PM
          Specification Done Specification Done Development Development
          48d 15h 47m 1 david.parafinski@ez.no 19/Apr/18 9:27 AM
          Development Development Development Done Development Done
          32d 31m 1 david.parafinski@ez.no 21/May/18 9:59 AM
          Development Done Development Done Documentation Documentation
          43s 1 david.parafinski@ez.no 21/May/18 10:00 AM
          Documentation Documentation Documentation Done Documentation Done
          3d 29m 1 Magdalena Zuba 24/May/18 10:29 AM
          Documentation Done Documentation Done Closed Closed
          49d 2m 1 Barbara Grajczyk 12/Jul/18 10:31 AM

            People

            • Assignee:
              Unassigned
              Reporter:
              Sylvain Guittard
            • Votes:
              0 Vote for this issue
              Watchers:
              9 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: