8000 fix: Allow frontend editing of page title fields (#8131) by fsbraun · Pull Request #8132 · django-cms/django-cms · GitHub
[go: up one dir, main page]
Skip to content

fix: Allow frontend editing of page title fields (#8131) #8132

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Feb 4, 2025
Merged

fix: Allow frontend editing of page title fields (#8131) #8132

merged 4 commits into from
Feb 4, 2025

Conversation

fsbraun
Copy link
Member
@fsbraun fsbraun commented Feb 3, 2025 •
edited
Loading

Description

Related resources

  • #...
  • #...

Checklist

  • I have opened this pull request against develop-4
  • I have added or modified the tests when changing logic
  • I have followed the conventional commits guidelines to add meaningful information into the changelog
  • I have read the contribution guidelines and I have joined the channel #pr-reviews on our Discord Server to find a “pr review buddy” who is going to review my pull request.

Summary by Sourcery

Bug Fixes:

  • Fix the frontend editing of page title fields.

@fsbraun
fix: Placeholder page getter failed for unpublished pages (django-cms…
dde308c 
…#8115)

* Fix: Placeholder page getter fails for unpublished pages

* Update cms/models/placeholdermodel.py

* Update cms/models/placeholdermodel.py
@fsbraun
Merge branch 'release/4.1.x' of github.com:django-cms/django-cms into…
1f07430 
… release/4.1.x
@fsbraun
fix: Allow frontend editing of page title fields (django-cms#8131)
542fb42
@sourcery-ai Sourcery AI
Copy link
Contributor
sourcery-ai bot commented Feb 3, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request introduces the ability to edit page title fields directly from the frontend. It adds a new endpoint to retrieve the form fields for editing page titles and modifies the PageAdmin class to specify which fields are editable from the frontend.

Sequence diagram for frontend page title editing flow

sequenceDiagram
    actor User
    participant Frontend
    participant PageAdmin
    participant Database

    User->>Frontend: Click edit title
    Frontend->>PageAdmin: Request editable fields
    PageAdmin-->>Frontend: Return title_frontend_editable_fields
    Frontend->>Frontend: Display edit form
    User->>Frontend: Edit title fields
    Frontend->>PageAdmin: Save changes
    PageAdmin->>Database: Update title fields
    Database-->>PageAdmin: Confirm update
    PageAdmin-->>Frontend: Return success
    Frontend-->>User: Show updated page
Loading

Class diagram showing updated PageAdmin with frontend editable fields

classDiagram
    class PageAdmin {
        +title_frontend_editable_fields: list
        +copy_form: CopyPageForm
        +move_form: MovePageForm
        +inlines: PERMISSION_ADMIN_INLINES
        +has_add_permission(request): bool
    }
    note for PageAdmin "Added title_frontend_editable_fields
for frontend editing capability"
Loading

File-Level Changes

Change Details Files
Added a new test case to verify the page edit field endpoint.
  • Added a test case test_page_edit_field_endpoint to verify the new endpoint.
  • The test case checks if the response contains the correct input field for the page title.
 cms/tests/test_admin.py
Modified the PageAdmin class to include a list of frontend editable fields.
  • Added title_frontend_editable_fields attribute to the PageAdmin class.
  • The title_frontend_editable_fields attribute specifies which fields are editable from the frontend: title, menu_title, and page_title.
 cms/admin/pageadmin.py
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai bot reviewed Feb 3, 2025
View reviewed changes
Copy link
Contributor
@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @fsbraun - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟡 Testing: 1 issue found
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@fsbraun fsbraun merged commit d8794b1 into django-cms:release/4.1.x Feb 4, 2025
90 of 91 checks passed
@fsbraun fsbraun deleted the fix/backport-8131 branch February 4, 2025 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@fsbraun
0