Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

make author merge description visible #9453

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

louisv20
Copy link

@louisv20 louisv20 commented Jun 20, 2024

Implement Author Description on Merge Page

Closes #9429

Description

This PR introduces the display of author descriptions on the merge page. The author descriptions will provide more context about each author during the merge process, improving the usability and user experience and helping librarians disambiguate authors, and avoid accidentally merging authors that shouldn't be merged.

Changes

  1. Conditional Display of Author Description:

    • Added logic to conditionally display the author description if it exists. If no description is available, a placeholder message "No description." will be shown.
    • Used the TruncateString macro to limit the displayed author description to 250 characters for better readability and to ensure a consistent layout.
  2. Updated Template:

    • Modified the HTML template to include the new logic for displaying author descriptions.
    • Maintained the existing template structure and ensured compatibility with the current styling and layout.

How to Test

  1. Run the Application:
    Ensure the application is running locally.

  2. Navigate to the Merge Page:
    Go to the merge page where authors are listed for merging.

  3. Verify Author Descriptions:

    • Check that authors with descriptions have their descriptions displayed, truncated to 250 characters.
    • Verify that authors without descriptions show the placeholder text "No description."
  4. Check for Errors:
    Ensure there are no errors or layout issues introduced by these changes.

Related Issues

Notes

  • This implementation uses the TruncateString macro to ensure descriptions are concise and fit within the layout.
  • The change has been tested across different browsers and screen sizes to ensure compatibility.

Checklist

  • Code follows the project's style guidelines.
  • Code is self-documented where necessary.
  • Tests have been added/updated to cover the changes.
  • All tests pass locally (docker compose run --rm home make test).

Additional Comments

Please review the changes and provide feedback. If there are any questions or further modifications required, let me know. Thank you!

Copy link
Collaborator

@RayBB RayBB left a comment

Choose a reason for hiding this comment

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

Working well, looks good to me!

@RayBB RayBB added the Needs: Staff / Internal Reviewed a PR but don't have merge powers? Use this. label Jun 24, 2024
@RayBB
Copy link
Collaborator

RayBB commented Jun 24, 2024

@cdrini this one is ready

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs: Staff / Internal Reviewed a PR but don't have merge powers? Use this.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Author merge endpoint should show the first few lines of the author's description
3 participants