-
Notifications
You must be signed in to change notification settings - Fork 4
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
zip2 readme #31
zip2 readme #31
Conversation
WalkthroughThe pull request involves modifications to the Changes
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 3
🧹 Nitpick comments (3)
README.md (3)
14-16
: Fix list indentation.The nested list items under "GitHub-Integration" have incorrect indentation according to Markdown standards.
Apply this change:
* GitHub-Integration: - * Installation direkt von GitHub-Repositories - * Repository-Suche nach Benutzer/Organisation - * Anzeige von Beschreibungen und Details der Repositories + * Installation direkt von GitHub-Repositories + * Repository-Suche nach Benutzer/Organisation + * Anzeige von Beschreibungen und Details der Repositories🧰 Tools
🪛 Markdownlint (0.37.0)
14-14: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
15-15: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
16-16: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
37-38
: Remove extra whitespace in URL list.There's unnecessary whitespace before the repository URL.
Apply this change:
-* Repository-URL: `https://github.com/FriendsOfREDAXO/demo_base` +* Repository-URL: `https://github.com/FriendsOfREDAXO/demo_base`🧰 Tools
🪛 LanguageTool
[uncategorized] ~37-~37: Das sieht falsch platziert oder unnötig aus. Überlegen Sie, es zu löschen.
Context: ...erden unterstützt: * Repository-URL:https://github.com/FriendsOfREDAXO/demo_base
* Spezifischer Branch: `https://github.com...(AI_DE_GGEC_UNNECESSARY_SPACE)
59-59
: Add hyphen to compound word.According to German language rules, "MIT Lizenz" should be written with a hyphen.
Apply this change:
-MIT Lizenz, siehe [LICENSE.md](LICENSE.md) +MIT-Lizenz, siehe [LICENSE.md](LICENSE.md)🧰 Tools
🪛 LanguageTool
[misspelling] ~59-~59: Dieses Wort wird mit Bindestrich geschrieben.
Context: ...rweiterungen: zip, fileinfo ## Lizenz MIT Lizenz, siehe LICENSE.md ## Aut...(DE_COMPOUNDS)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md
(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~3-~3: Meinten Sie das Nomen „Add-on“ (= Erweiterung, Zubehörteil)?
Context: ...n-Installation via ZIP & GitHub Dieses AddOn ermöglicht die einfache Installation vo...
(ADD_ON)
[uncategorized] ~3-~3: Meinten Sie das Nomen „Add-ons“ (= Erweiterung, Zubehörteil)?
Context: ...rmöglicht die einfache Installation von AddOns oder Plugins durch Hochladen von ZIP-Da...
(ADD_ON)
[uncategorized] ~3-~3: Hier scheint ein Satzzeichen zu fehlen. Überlegen Sie, es einzufügen.
Context: ...e einfache Installation von AddOns oder Plugins durch Hochladen von ZIP-Dateien, Instal...
(AI_DE_GGEC_MISSING_PUNCTUATION_PLUGDASHINS)
[uncategorized] ~5-~5: Meinten Sie das Nomen „Add-on“ (= Erweiterung, Zubehörteil)?
Context: ...on GitHub. **WICHTIGER HINWEIS: Dieses AddOn sind ausschließlich für erfahrene Syste...
(ADD_ON)
[uncategorized] ~27-~27: Meinten Sie das Nomen „Add-on“ (= Erweiterung, Zubehörteil)?
Context: ...tivierung in REDAXO ## Verwendung Das AddOn ist im Installer unter "ZIP Upload/GitH...
(ADD_ON)
[uncategorized] ~29-~29: Meinten Sie das Nomen „Add-ons“ (= Erweiterung, Zubehörteil)?
Context: ...: Direkter Upload einer ZIP-Datei eines AddOns/Plugins 2. URL-Installation: Einga...
(ADD_ON)
[uncategorized] ~37-~37: Das sieht falsch platziert oder unnötig aus. Überlegen Sie, es zu löschen.
Context: ...erden unterstützt: * Repository-URL: https://github.com/FriendsOfREDAXO/demo_base
* Spezifischer Branch: `https://github.com...
(AI_DE_GGEC_UNNECESSARY_SPACE)
[uncategorized] ~40-~40: Hier scheint ein Satzzeichen zu fehlen. Überlegen Sie, es einzufügen.
Context: ...iendsOfREDAXO/demo_base/tree/main` ### Plugins Plugins werden automatisch in das ents...
(AI_DE_GGEC_MISSING_PUNCTUATION_PLUGDASHINS)
[uncategorized] ~42-~42: Meinten Sie das Nomen „Add-ons“ (= Erweiterung, Zubehörteil)?
Context: ...tsprechende Verzeichnis des zugehörigen AddOns installiert. Der Name wird dabei automa...
(ADD_ON)
[uncategorized] ~46-~46: Meinten Sie das Nomen „Add-on“ (= Erweiterung, Zubehörteil)?
Context: ...rnommen. ## Wichtige Hinweise * Das AddOn überschreibt vorhandene Dateien ohne Rü...
(ADD_ON)
[uncategorized] ~49-~49: Meinten Sie das Nomen „Add-ons“ (= Erweiterung, Zubehörteil)?
Context: ...nicht geprüft. * Die update.php
des AddOns wird nicht ausgeführt. * Der Upload i...
(ADD_ON)
[misspelling] ~59-~59: Dieses Wort wird mit Bindestrich geschrieben.
Context: ...rweiterungen: zip, fileinfo ## Lizenz MIT Lizenz, siehe LICENSE.md ## Aut...
(DE_COMPOUNDS)
[typographical] ~60-~60: Zeichen ohne sein Gegenstück: ‚]‘ scheint zu fehlen
Context: ... fileinfo ## Lizenz MIT Lizenz, siehe LICENSE.md ## Autor * [...
(UNPAIRED_BRACKETS)
[uncategorized] ~68-~68: Meinten Sie das Nomen „Add-on“ (= Erweiterung, Zubehörteil)?
Context: ...AXO) ## Danksagung * Ursprüngliches AddOn von [@aeberhard](https://github.com/aeb...
(ADD_ON)
🪛 Markdownlint (0.37.0)
README.md
14-14: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
15-15: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
16-16: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
|
||
### Plugins | ||
|
||
Plugins werden automatisch in das richtige Verzeichnis des zugehörigen AddOns installiert. Der Name wird dabei automatisch aus der package.yml übernommen. | ||
Plugins werden automatisch in das entsprechende Verzeichnis des zugehörigen AddOns installiert. Der Name wird dabei automatisch aus der `package.yml` übernommen. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Standardize Add-on terminology in technical sections.
Continue the standardization of "AddOn" to "Add-on" in the technical sections.
Apply these changes:
-Plugins werden automatisch in das entsprechende Verzeichnis des zugehörigen AddOns installiert.
+Plugins werden automatisch in das entsprechende Verzeichnis des zugehörigen Add-ons installiert.
-* Das AddOn überschreibt vorhandene Dateien ohne Rückfrage.
+* Das Add-on überschreibt vorhandene Dateien ohne Rückfrage.
-* Die `update.php` des AddOns wird nicht ausgeführt.
+* Die `update.php` des Add-ons wird nicht ausgeführt.
Also applies to: 46-46, 49-49
🧰 Tools
🪛 LanguageTool
[uncategorized] ~42-~42: Meinten Sie das Nomen „Add-ons“ (= Erweiterung, Zubehörteil)?
Context: ...tsprechende Verzeichnis des zugehörigen AddOns installiert. Der Name wird dabei automa...
(ADD_ON)
* Ursprüngliches AddOn von [@aeberhard](https://github.com/aeberhard) | ||
* GitHub-Integration inspiriert von [@skerbis](https://github.com/skerbis) | ||
* Weiterentwicklung durch die [Friends Of REDAXO](https://github.com/FriendsOfREDAXO) | ||
* Ursprüngliches AddOn von [@aeberhard](https://github.com/aeberhard) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Final terminology standardization.
Complete the standardization of Add-on terminology in the acknowledgments section.
Apply this change:
-* Ursprüngliches AddOn von [@aeberhard](https://github.com/aeberhard)
+* Ursprüngliches Add-on von [@aeberhard](https://github.com/aeberhard)
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
* Ursprüngliches AddOn von [@aeberhard](https://github.com/aeberhard) | |
* Ursprüngliches Add-on von [@aeberhard](https://github.com/aeberhard) |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~68-~68: Meinten Sie das Nomen „Add-on“ (= Erweiterung, Zubehörteil)?
Context: ...AXO) ## Danksagung * Ursprüngliches AddOn von [@aeberhard](https://github.com/aeb...
(ADD_ON)
Dieses AddOn ermöglicht die einfache Installation von AddOns oder Plugins durch Hochladen von ZIP-Dateien, Installation über eine URL oder direkt von GitHub. | ||
|
||
**WICHTIGER HINWEIS: Dieses AddOn sind ausschließlich für erfahrene Systemadministrator:innen bestimmt. Die unsachgemäße Anwendung kann zu unerwartetem Verhalten oder Schäden führen.** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Standardize terminology and fix grammar.
The term "AddOn" should be consistently written as "Add-on" throughout the document according to German language conventions. Additionally, there's a subject-verb agreement issue in line 5.
Apply these changes:
-Dieses AddOn ermöglicht die einfache Installation von AddOns oder Plugins durch Hochladen von ZIP-Dateien, Installation über eine URL oder direkt von GitHub.
+Dieses Add-on ermöglicht die einfache Installation von Add-ons oder Plugins durch Hochladen von ZIP-Dateien, Installation über eine URL oder direkt von GitHub.
-**WICHTIGER HINWEIS: Dieses AddOn sind ausschließlich für erfahrene Systemadministrator:innen bestimmt.
+**WICHTIGER HINWEIS: Dieses Add-on ist ausschließlich für erfahrene Systemadministrator:innen bestimmt.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Dieses AddOn ermöglicht die einfache Installation von AddOns oder Plugins durch Hochladen von ZIP-Dateien, Installation über eine URL oder direkt von GitHub. | |
**WICHTIGER HINWEIS: Dieses AddOn sind ausschließlich für erfahrene Systemadministrator:innen bestimmt. Die unsachgemäße Anwendung kann zu unerwartetem Verhalten oder Schäden führen.** | |
Dieses Add-on ermöglicht die einfache Installation von Add-ons oder Plugins durch Hochladen von ZIP-Dateien, Installation über eine URL oder direkt von GitHub. | |
**WICHTIGER HINWEIS: Dieses Add-on ist ausschließlich für erfahrene Systemadministrator:innen bestimmt. Die unsachgemäße Anwendung kann zu unerwartetem Verhalten oder Schäden führen.** |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: Meinten Sie das Nomen „Add-on“ (= Erweiterung, Zubehörteil)?
Context: ...n-Installation via ZIP & GitHub Dieses AddOn ermöglicht die einfache Installation vo...
(ADD_ON)
[uncategorized] ~3-~3: Meinten Sie das Nomen „Add-ons“ (= Erweiterung, Zubehörteil)?
Context: ...rmöglicht die einfache Installation von AddOns oder Plugins durch Hochladen von ZIP-Da...
(ADD_ON)
[uncategorized] ~3-~3: Hier scheint ein Satzzeichen zu fehlen. Überlegen Sie, es einzufügen.
Context: ...e einfache Installation von AddOns oder Plugins durch Hochladen von ZIP-Dateien, Instal...
(AI_DE_GGEC_MISSING_PUNCTUATION_PLUGDASHINS)
[uncategorized] ~5-~5: Meinten Sie das Nomen „Add-on“ (= Erweiterung, Zubehörteil)?
Context: ...on GitHub. **WICHTIGER HINWEIS: Dieses AddOn sind ausschließlich für erfahrene Syste...
(ADD_ON)
Summary by CodeRabbit