search

ckeditor / ckeditor5

Powerful rich text editor framework with a modular architecture, modern integrations, and features like collaborative editing.
https://ckeditor.com/ckeditor-5
Other
8.28k stars 3.59k forks source link

Docs: adding Drupal feature pack docs. #16254

Closed godai78 closed 3 weeks ago

godai78 commented 3 weeks ago

Suggested merge commit message (convention)

Docs: adding Drupal feature pack docs.

Additional information

Ported from https://github.com/ckeditor/ckeditor5/pull/16253

Summary by CodeRabbit

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The recent update focuses on expanding CKEditor functionality within Drupal by introducing comprehensive documentation for the CKEditor 5 Plugin Pack module. This addition aims to provide users with a detailed understanding of the module's features, premium functionalities, system prerequisites, and a clear installation process. The goal is to improve user experience by offering extensive guidance on integrating and utilizing CKEditor in Drupal environments.

Changes

File Path Change Summary
docs/.../drupal-real-time-collaboration.md Added information about the CKEditor 5 Plugin Pack module, including its features, premium features, requirements, and installation instructions, enhancing the functionality and options available for CKEditor in Drupal.
Recent Review Details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 9c6112828b55efd0e6b266a1b3c96a2ea1dd5601 and 921ca2714f47ff4c8358d6131170d88ea2127903.
Files selected for processing (1) * docs/installation/integrations/drupal-real-time-collaboration.md (1 hunks)
Additional Context Used
LanguageTool (30)
docs/installation/integrations/drupal-real-time-collaboration.md (30)
Near line 14: Possible spelling mistake found. Context: ...management system (CMS) written in PHP. CKEditor 5 WYSIWYG rich text editor is the defau... --- Near line 14: Possible spelling mistake found. Context: ... default editor module for Drupal. The [CKEditor 5 Premium Features module](https://www.... --- Near line 16: Possible typo: you repeated a word Context: ... includes a full set of {@link features/collaboration collaboration tools}, namely comments, track changes,... --- Near line 16: Possible spelling mistake found. Context: ...es/productivity-pack Productivity Pack} – a set of essential formatting and navi... --- Near line 20: Possible spelling mistake found. Context: ...pplications for drafting and commenting – you can do it all in one place. {@img... --- Near line 22: Possible spelling mistake found. Context: ...n do it all in one place. {@img assets/img/real-time-collaboration-drupal.gif 1014... --- Near line 22: Possible spelling mistake found. Context: ...llaboration-drupal.gif 1014 Drupal with CKEditor 5 real-time collaborative editing.} ##... --- Near line 26: Possible typo: you repeated a word Context: ...## Adding comments The {@link features/comments comments} feature allows users to discuss the co... --- Near line 36: An apostrophe may be missing. Context: ...There is also a dedicated, configurable notifications system developed especially for the CKE... --- Near line 36: Possible spelling mistake found. Context: ...ons system developed especially for the CKEditor 5 Premium Features module for Drupal. I... --- Near line 36: An apostrophe may be missing. Context: ...ecially for the CKEditor 5 Premium Features module for Drupal. It helps you stay up... --- Near line 44: Possible typo: you repeated a word Context: ... edited text, while the {@link features/mentions mentions} feature allows you to tag other users ... --- Near line 48: If this is a compound adjective that modifies the following noun, use a hyphen. Context: ...s, or lists. ### Full-screen mode The full screen mode is a free-to-use plugin that maxim... --- Near line 48: Possible typo: you repeated a word Context: ...ne document outline} or {@link features/comments comments} that take up extra space around the ed... --- Near line 52: Possible missing comma found. Context: ...ce-enhanced paste from Office enhanced} feature which makes pasting advanced rich-text ... --- Near line 52: Possible spelling mistake found. Context: ...editor, handy one-click {@link features/export-pdf export to PDF} and {@link features/expo... --- Near line 60: Possible spelling mistake found. Context: ...ersions * Drupal 9 (requires [enabling CKEditor–5](https://www.drupal.org/docs/core-mod... --- Near line 66: Possible spelling mistake found. Context: ...uirements * PHP 8.0+ * Drupal 9.4 with CKEditor–5 enabled * Drupal 10 ## Installation ... --- Near line 71: Possible spelling mistake found. Context: ...and configuration Refer to the [Adding CKEditor–5 Premium Features module to Drupal 10]... --- Near line 71: An apostrophe may be missing. Context: ...to the [Adding CKEditor–5 Premium Features module to Drupal 10](https://www.drupal... --- Near line 75: Possible spelling mistake found. Context: ...odule. ## CKEditor 5 Plugin Pack The [CKEditor 5 Plugin Pack](https://www.drupal.org/p... --- Near line 82: Possible typo: you repeated a word Context: ...ily, size and colors} * {@link features/highlight Highlight} * {@link features/text-transformation ... --- Near line 84: Possible spelling mistake found. Context: ... Text transformation} * {@link features/todo-lists To-do lists} * {@link features/word-cou... --- Near line 86: Possible spelling mistake found. Context: ... features/spelling-and-grammar-checking WProofreader} – limitation of the free version... --- Near line 86: Possible spelling mistake found. Context: ...ling-and-grammar-checking WProofreader} – limitation of the free version are lis... --- Near line 86: Unpaired symbol: ‘]’ seems to be missing Context: ...mitation of the free version are listed [on this page](https://www.drupal.org/doc... --- Near line 87: Possible missing article found. Context: ...er-free-vs-premium-feature-comparison) Plugin Pack also makes it possible to use some... --- Near line 89: A comma may be missing after the conjunctive/linking adverb ‘Currently’. Context: ...ome of the premium features for free. Currently available premium features: * {@link f... --- Near line 95: Unpaired symbol: ‘]’ seems to be missing Context: ...ions of each plugin can be found on the [CKEditor 5 Plugin Pack module page]... --- Near line 95: Possible spelling mistake found. Context: ...ons of each plugin can be found on the [CKEditor 5 Plugin Pack module page](https://www....
Additional comments not posted (1)
docs/installation/integrations/drupal-real-time-collaboration.md (1)
`75-106`: Ensure all links are functional and complete any TODO placeholders. Please verify that all links, especially those in the newly added section, are functional and lead to the correct resources. Additionally, ensure that any TODO placeholders are completed or removed if the information is not ready.
--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.