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

docs: revise moderation feature documentation and enhance navigation #727

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

Conversation

Samk13
Copy link
Member

@Samk13 Samk13 commented Nov 22, 2024

❤️ Thank you for your contribution!

Description

  • Removed outdated screenshots referencing "suspend."
  • Added a new page under the "Features" section for administration.
  • Moved text from the "Release" section to the new feature page to serve as a teaser rather than a full description.

This is an initial draft that can certainly be extended and improved, feel free to build upon it!

Checklist

Ticks in all boxes and 🟢 on all GitHub actions status checks are required to merge:

  • I'm aware of the code of conduct.
  • I've created logical separate commits and followed the commit message format.
  • I've targeted the master branch.
  • If this documentation change impacts the current release of InvenioRDM, I will backport it to the production branch following approval or indicate to a maintainer that it should be backported.

Reminder

By using GitHub, you have already agreed to the GitHub’s Terms of Service including that:

  1. You license your contribution under the same terms as the current repository’s license.
  2. You agree that you have the right to license your contribution under the current repository’s license.

@Samk13 Samk13 requested review from carlinmack and Copilot November 22, 2024 16:40

Choose a reason for hiding this comment

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

Copilot reviewed 5 out of 5 changed files in this pull request and generated no suggestions.

Comments skipped due to low confidence (1)

docs/features/moderation.md:12

  • The phrase 'Deactivating a user temporarily prevents them from creating records, but lets them appeal their deactivation.' is repeated.
The administration panel now includes a "User management" section to deactivate, block and delete users, as well as undo all those actions. Deactivating a user temporarily prevents them from creating records, but lets them appeal their deactivation. Blocked users cannot sign in anymore and deleted users are removed from the system.
@Samk13 Samk13 force-pushed the fix-administration branch 2 times, most recently from 712a307 to 2505b62 Compare November 22, 2024 16:46
@Samk13 Samk13 requested a review from Copilot November 22, 2024 16:47

Choose a reason for hiding this comment

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

Copilot reviewed 5 out of 5 changed files in this pull request and generated no suggestions.

Comments skipped due to low confidence (2)

docs/features/moderation.md:12

  • The term 'deactivate' is inconsistent with the previously used term 'suspend'. It should be renamed to 'suspend' for consistency.
The administration panel now includes a "User management" section to deactivate, block and delete users, as well as undo all those actions.

docs/releases/v12/version-v12.0.0.md:64

  • The term 'suspend' should be replaced with 'deactivate' to match the terminology used in the new documentation.
The administration panel now includes a "User management" section to suspend, block and delete users, as well as undo all those actions.
@Samk13
Copy link
Member Author

Samk13 commented Nov 22, 2024

I like this new Copilot review feature! 😍

@Samk13 Samk13 force-pushed the fix-administration branch from 2505b62 to edd284a Compare November 22, 2024 16:52
@Samk13 Samk13 requested a review from Copilot November 22, 2024 16:52
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 suggestion.

* Removed outdated screenshots referencing "suspend."
* Added a new page under the "Features" section for administration.
* Moved text from the "Release" section to the new feature page to serve as a teaser rather than a full description.
@Samk13 Samk13 force-pushed the fix-administration branch from edd284a to d5605ec Compare November 22, 2024 16:54
@Samk13 Samk13 requested a review from Copilot November 22, 2024 16:55
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 suggestions.

@@ -49,6 +49,7 @@ nav:
- Customizable: "features/customization.md"
- Interoperable: "features/interoperable.md"
- Powerful: "features/powerful.md"
- Moderation: "features/moderation.md"
Copy link
Contributor

@tmorrell tmorrell Nov 22, 2024

Choose a reason for hiding this comment

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

I don't think this is a top level item. They are going to get reorganized anyway probably when @fenekku is back, but I would put it under Features walk-through for now.

Copy link
Collaborator

Choose a reason for hiding this comment

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

(and I am back)

Yes, I agree with @tmorrell, let's put those under walk-through for now. As talked in documentation group there will be some reorg in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants