Skip to content

docs: Fix instructions on setting editor permissions #8208

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 3 commits into from
Apr 26, 2025
Merged

docs: Fix instructions on setting editor permissions #8208

merged 3 commits into from
Apr 26, 2025

Conversation

shundread
Copy link
Contributor

@shundread shundread commented Apr 26, 2025 •
edited by sourcery-ai bot
Loading

Description

Without the versioning permissions, an editor cannot begin editing a page. Without the frontend permissions, no components other than comment shows up, without alias/alias versioning permissions an editor cannot edit aliases, without rich text permissions an editor cannot add text blocks, cms | placeholder reference was mentioned twice and cms | title does not seem to exist any longer.

Related resources

  • #...
  • #...

Checklist

  • I have opened this pull request against main
  • 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

Documentation:

  • Correct the list of required permissions for editors, adding missing ones and removing outdated entries.

@sourcery-ai Sourcery AI
Copy link
Contributor

sourcery-ai bot commented Apr 26, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request updates the documentation file docs/explanation/permissions.rst to provide accurate instructions on setting editor permissions. It adds necessary permissions like versioning, frontend, alias, and rich text, and corrects inaccuracies by removing outdated or duplicate entries.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Update documentation for editor permissions
  • Add instructions for versioning permission required for editing pages.
  • Add instructions for frontend permission required for seeing components.
  • Add instructions for alias and alias versioning permissions required for editing aliases.
  • Add instructions for rich text permissions required for adding text blocks.
  • Remove outdated instruction for `cms
 titlepermission.</li><li>Correct duplicate mention ofcms
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!

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 Apr 26, 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 @shundread - 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: all looks good
  • 🟢 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
Copy link
Member

fsbraun commented Apr 26, 2025

@shundread Thank you for the pull request. Great work!

I would like to clearly differentiate between the permissions of the core, and maybe put remarks on other permissions (frontend, versioning) into a .. note: box to point people at the appropriate docs (as available).

Also, can you explain that plugins (other packages, custom plugins) need their permissions set?

@shundread shundread force-pushed the fix/permissions-instructions branch 2 times, most recently from 53df3d2 to 61d1e55 Compare April 26, 2025 09:23
@shundread
Copy link
Contributor Author

Only djangocms-frontend had any accessible documentation on how to add the permissions, so it's the only one whose documentation was linked. The extra packages mentioned had their pypy pages linked.

fsbraun
fsbraun requested changes Apr 26, 2025
View reviewed changes
Copy link
Member

@fsbraun fsbraun left a comment

Choose a reason for hiding this comment

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

This is also true for any custom plugins, right?

@shundread shundread force-pushed the fix/permissions-instructions branch from 61d1e55 to 6020014 Compare April 26, 2025 09:48
@fsbraun
Copy link
Member

fsbraun commented Apr 26, 2025

@MacLake Would you like to take a look at this?

@MacLake
Copy link
Contributor

MacLake commented Apr 26, 2025

We can delete the line django CMS | static placeholder. Apart from that this is okay.

MacLake
MacLake suggested changes Apr 26, 2025
View reviewed changes
Copy link
Contributor

@MacLake MacLake left a comment

Choose a reason for hiding this comment

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

Your changes are correct, thanks for that. static placeholders are not used from version 4 anymore.

@fsbraun @MacLake
Update docs/explanation/permissions.rst
5857844 
Co-authored-by: Jens-Erik Weber <MacLake@users.noreply.github.com>
fsbraun
fsbraun approved these changes Apr 26, 2025
View reviewed changes
Copy link
Member

@fsbraun fsbraun left a comment

Choose a reason for hiding this comment

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

@shundread Thank you! Great work!

MacLake
MacLake approved these changes Apr 26, 2025
View reviewed changes
Copy link
Contributor

@MacLake MacLake left a comment

Choose a reason for hiding this comment

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

Ok, thanks!

@fsbraun fsbraun merged commit 2e7b83e into django-cms:develop-4 Apr 26, 2025
63 checks passed
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

@MacLake MacLake MacLake approved these changes

@fsbraun fsbraun fsbraun approved these changes

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

Successfully merging this pull request may close these issues.
3 participants
@shundread @fsbraun @MacLake