Details

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

      Description

      Hi,

      When I go to the developer doc through doc.ez.no, I land on RTD with the selected version being 1.7 LTS. I guess this is desired behavior.
      However, as a user, I most likely have no clue about that, then I go to the Release notes section in the nav, and see only release notes up to 1.7 and it can lead me to understand there are no more recent releases.

      Hence I am wondering if we could not improve:

      • either having the release notes section always backported to previous versions
      • or make the reader much more aware of the "selected versions' and the fact that there might be more recent release notes...

      Any idea would be welcome, I just got trapped myself with this, so I guess some others might be missled too.

        Activity

        Hide
        Dominika Kurek added a comment -

        As an explanation: Redirections from the old doc point to the 1.7 version to avoid broken links. The status of the doc on Confluence was closest to the 1.7 version. If we used a more recent version, some addresses would be redirecting to pages that do not exist in the newest version.

        But in general I agree, we will have to think about some solution to this. The problem will be partly alleviated when this improvement to the doc site is done: https://jira.ez.no/browse/EZP-27826. It will add a visual warning when previewing a doc version that is not the most current one (sort of like Symfony doc does for its unmaintained versions, see http://symfony.com/doc/3.0/setup.html)

        Show
        Dominika Kurek added a comment - As an explanation: Redirections from the old doc point to the 1.7 version to avoid broken links. The status of the doc on Confluence was closest to the 1.7 version. If we used a more recent version, some addresses would be redirecting to pages that do not exist in the newest version. But in general I agree, we will have to think about some solution to this. The problem will be partly alleviated when this improvement to the doc site is done: https://jira.ez.no/browse/EZP-27826 . It will add a visual warning when previewing a doc version that is not the most current one (sort of like Symfony doc does for its unmaintained versions, see http://symfony.com/doc/3.0/setup.html )
        Hide
        Dominika Kurek added a comment -

        PR adding the "future" release notes to 1.7 branch: https://github.com/ezsystems/developer-documentation/pull/110

        From now on we should simply make sure to add new release notes to all active branches.

        Show
        Dominika Kurek added a comment - PR adding the "future" release notes to 1.7 branch: https://github.com/ezsystems/developer-documentation/pull/110 From now on we should simply make sure to add new release notes to all active branches.
        Hide
        Dominika Kurek added a comment -

        Roland Benedetti, all the release notes will from now on be added to all active doc versions, and https://jira.ez.no/browse/EZP-27826 will take care of making it clear which version of the doc the user is reading.

        Show
        Dominika Kurek added a comment - Roland Benedetti , all the release notes will from now on be added to all active doc versions, and https://jira.ez.no/browse/EZP-27826 will take care of making it clear which version of the doc the user is reading.

          People

          • Assignee:
            Unassigned
            Reporter:
            Roland Benedetti
          • Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: