Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Release notes + homepage redesign #2652

Merged
merged 23 commits into from
Mar 26, 2025
Merged

Release notes + homepage redesign #2652

merged 23 commits into from
Mar 26, 2025

Conversation

mnocon
Copy link
Contributor

@mnocon mnocon commented Mar 5, 2025

Target: master, 4.6

How to review:

Frontend:

  • All the SVG, CSS, SCSS, JS, .eslintignore changes are done by @GrabowskiM and should not be reviewed

My changes:

Adding a new release

You can add a new release as in the following example:

[[% set version = 'v4.6.11' %]] # Required if the change log snippet is used
[[= release_note_entry_begin("Ibexa DXP " + version, '2024-09-16', ['Headless', 'Experience', 'Commerce']) =]] # Required: specifes the title of the release, release date and categories. Available categories are: 'Headless', 'Experience', 'Commerce', 'LTS Update', 'New feature'

#### Section header

You can use Markdown here, as usual

[[% include 'snippets/release_46.md' %]] # Optional, generates the full change logs and update guide link. Version variable must be set to use this
[[= release_note_entry_end() =]]

Previews

@mnocon mnocon changed the title Data structure + some changes Release notes + homepage redesign Mar 5, 2025
@mnocon mnocon force-pushed the redesign-release-notes branch from fdf2d67 to d9d921d Compare March 18, 2025 22:11
@mnocon mnocon marked this pull request as ready for review March 19, 2025 08:51
docs/index.md Outdated
<div class="notification notification--latest-release" id="tile2">
<div class="notification__content">
<h2>The latest release is [[= latest_tag_4_6 =]]</h2>
<div>The <a href="release_notes/ibexa_dxp_v4.6/">latest version of Ibexa DXP is [[= latest_tag_4_6 =]]</a>. You can now update your application to the latest version.</div>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The two tiles seem misaligned, with the LTS Updates one being slightly lower. Aalso, there is more whitespace in the LTS Update one. The "LTS Updates List" link calls for a button.

image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Zrzut ekranu 2025-03-26 o 00 14 37

Fixed alignment and height for the boxes. I'm not sure if the button is better, so I'd stick with the design here

<div>The <a href="release_notes/ibexa_dxp_v4.6/">latest version of Ibexa DXP is [[= latest_tag_4_6 =]]</a>. You can now update your application to the latest version.</div>
</div>
<div class="notification__cta">
<a href="release_notes/ibexa_dxp_v4.6/">Release notes</a>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We already have a link to the release notes in line 78. How about a link to the upgrade/update instructions, like we had to date?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

People should go to the update instructions through the release notes first, I think it's a good order.

I've removed the link from line 79 completely - with 3 options (release notes, latest lts update, lts updates list) it's enough choice for the visitor and that link was barely visible anyway.

docs/index.md Outdated
</div>
<div class="notification__cta">
<a href="update_and_migration/from_4.5/update_from_4.5/">Update your application</a>
<a href="pim/attributes/date_and_time">More about Date and Time attribute type</a>
<a href="ibexa_products/editions#lts-updates">LTS Updates List</a>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<a href="ibexa_products/editions#lts-updates">LTS Updates List</a>
<a href="ibexa_products/editions#lts-updates">Discover other LTS Updates</a>

`
I would put it on a button, it looks lost without one

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Applied the text suggestion, I'd stick with the design when it comes to the button


**Release date**: February 13, 2024
[[% set version = 'v4.6.18' %]]
[[= release_note_entry_begin("Ibexa DXP " + version, '2025-03-06', ['Headless', 'Experience', 'Commerce']) =]]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was wondering:

  1. whether we need edition pills next to each release number. Was there ever a version released for less than three editions? I'd say this is redundant information.
  2. why these pills are different from the pills visible when within the article below, we should be consistent visually
  3. do we need "New feature" pill if right below the pills we have the "Features" header. I'd say not, because if a version has new features, it is very well visible because their list is right below the version number.

IMVHO there's too much clutter, too many colors.

image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. We need them for the filters to work, and if we release an LTS update available not available for Headless then it would be useful. I'd keep it and we can revisit it in the future if needed.
  2. I've discussed this with @GrabowskiM - we will align the pills visually once this is merged to keep the scope of this PR small
  3. I'd keep it as it works well with filtering - you can have a quick a glance of what was added in the recent releases

@mnocon mnocon requested a review from dabrt March 26, 2025 07:38
@mnocon mnocon merged commit b57d887 into master Mar 26, 2025
7 checks passed
@mnocon mnocon deleted the redesign-release-notes branch March 26, 2025 15:05
mnocon added a commit that referenced this pull request Mar 26, 2025
* Data structure + some changes

* js and css for release notes

* filters

* minor changes

* front

* fixes to front

* spacing

* Refactoring - first part

* Added list of LTS updates

* Added category validation

* headers

* Removed commented code

* Python 3.8 fix

* Fixed links

* Removed TMP change

* Link ixes

* Removed maps and commented code

* Fixed client type for Ibexa Connect

* Review fixes

* Fixed broken link

* Button alignment

---------

Co-authored-by: Michał Grabowski <michal.grabowski@ibexa.co>
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants