Closed (fixed)
Project:
Flood control
Version:
3.0.0
Component:
Documentation
Priority:
Normal
Category:
Task
Assigned:
Issue tags:
Reporter:
Created:
6 Jan 2026 at 18:38 UTC
Updated:
12 Jun 2026 at 07:50 UTC
Jump to comment: Most recent
Comments
Comment #2
batigolixComment #3
aayushpathak commentedworking !
Comment #5
aayushpathak commentedI have updated the README to include detailed sections for installation, configuration, usage, and features.
Also added an AGENTS.md file for AI-related guidance and improved project page content for clarity and completeness.
Please review.
Comment #6
aayushpathak commentedComment #7
batigolixI am sorry, but I should have stated in the description that the readme should follow the template at https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...
(I ll update the description)
Your changes in the readme do not follow that template. They overwrite sections that were already good.
As for the project page:
- create and commit a project-page.html
- ensure the current information does not get lost (rewriting is OK)
- explain features and related modules
Comment #8
batigolixComment #9
aayushpathak commentedThanks for the clarification
I have Updated README.md to follow Drupal README template while preserving existing content
Added project-page.html with features and related modules
Ensured existing information is retained and improved for clarity
Please review.
Comment #10
aayushpathak commentedComment #11
angel_devoeted commentedThanks @aayushpathak for working on this! I took a look at the latest diff. The project-page.html and AGENTS.md look solid, but I just wanted to point out a couple of things:
- The README is still missing the
## INTRODUCTIONheading right at the top, which is part of the standard template.- It looks like the old
## Manage flood table sectionis still deleted. Like @batigolix mentioned in #7, we should probably keep that original text intact.- I noticed some changes in
tests/src/Kernel/MigrateFloodControlTest.phpandValidateD7MigrationStateTest.php(adding conditionals and phpcs:ignoreFile). Just wondering, is there a specific reason we need to include these test modifications in this documentation issue?Comment #12
aayushpathak commentedThanks for the feedback.
I have updated the README.md as discussed to align with the Drupal template, including adding the Introduction section and restoring the original “Manage flood table” content.
I have also reverted the changes made to the test files to keep the scope limited to documentation. Those changes were initially made to address pipeline issues, but I understand they are out of scope for this issue.
Please review the updated patch.
Comment #13
angel_devoeted commentedThanks @aayushpathak for the quick update and for reverting the test files! That keeps the MR nice and clean.
The README is looking much closer to the template now. I just noticed two quick things we need to tweak:
- In the restored "Manage flood table" section, the original step-by-step instructions are still missing. To ensure we don't lose that helpful information (as requested in comment #7), could you append the original
### Stepsback into that section?- Just a minor detail to strictly match the Drupal README template: the main headings are traditionally written in ALL CAPS (e.g.,
## INTRODUCTION,## REQUIREMENTS,## CONFIGURATION, etc.). Would you mind updating the capitalization of the main headers as well?Comment #14
aayushpathak commentedSorry for the confusion and multiple iterations. I have now addressed all the feedback. Please review the updated patch.
Comment #15
batigolixThanks for the attempts. I think you need to understand the module better to make real documentation improvements.
I'll finish this.
Comment #16
batigolixThis can be reviewed
Comment #17
batigolixComment #18
fabianderijkI'll take a look at the changes @batigolix
Comment #19
fabianderijkI've reviewed the changes, and everything looks okay too me. @batigolix you can merge this if you want
Comment #21
batigolixThanks everybody, for helping out with this one