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

Document which Symfony settings should never be altered

    Details

    • Type: Story Story
    • Status: Closed
    • Priority: High High
    • Resolution: Invalid
    • Affects Version/s: 5.0, 5.1-dev
    • Fix Version/s: QA tracked issues
    • Component/s: Documentation
    • Labels:
      None

      Description

      Because we use Symfony we have a mixture of Symfony specific and eZ Publish specific settings in YAML files.

      After a discussion with BD concerning some REST v2 settings, I learned that there are certain settings eZ consider should never be changed.
      An example here was in security.yml :

                  pattern: ^/api/ezp/v2
      

      What settings that developers are not supposed to changed and are settings which need to remain as-is in order for eZ Publish to work properly needs to be documented

        Issue Links

          Activity

          Hide
          Vidar Langseid added a comment - - edited

          I don't say we should go through every symfony settings and say you may or may not use is.

          But every settings defined in our .yml files out of the box, and which the user should never alter must be documented....
          Or else, people will start changing them to tweek the system in ways it was never meant to work

          Show
          Vidar Langseid added a comment - - edited I don't say we should go through every symfony settings and say you may or may not use is. But every settings defined in our .yml files out of the box, and which the user should never alter must be documented.... Or else, people will start changing them to tweek the system in ways it was never meant to work
          Hide
          Vidar Langseid added a comment -

          My point at the time I created this ticket was that we have configurations settings that appear as changable settings, but elsewhere (in code etc) are hardcoded so the setting cannot really be changed without breaking stuff.
          This was in contrast to old eZ Publish where you could change any setting really, as long as you knew what you where doing.

          eZ Platform is build in a different way, on top of Symfony and I no longer think this issue is valid. To figure out and document what settings you may not change under any circumstance is not feasible or worth the effort.

          Show
          Vidar Langseid added a comment - My point at the time I created this ticket was that we have configurations settings that appear as changable settings, but elsewhere (in code etc) are hardcoded so the setting cannot really be changed without breaking stuff. This was in contrast to old eZ Publish where you could change any setting really, as long as you knew what you where doing. eZ Platform is build in a different way, on top of Symfony and I no longer think this issue is valid. To figure out and document what settings you may not change under any circumstance is not feasible or worth the effort.

            People

            • Assignee:
              Unassigned
              Reporter:
              Vidar Langseid
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: