Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
The developer documentation has a recommended template for README files. This task is to update this modules README file to more closely match this template.
Comment | File | Size | Author |
---|---|---|---|
#11 | 2933484-11.patch | 5.35 KB | shubham.prakash |
| |||
#8 | interdiff-5-8.txt | 2.85 KB | Vidushi Mehta |
#8 | 2933484-8.patch | 5.59 KB | Vidushi Mehta |
| |||
#5 | 2933484-5.patch | 5.46 KB | bhanuprakashnani |
| |||
#3 | after_updating_readme-2933484-1.JPG | 52.94 KB | Eitisha |
Comments
Comment #2
Akanksha92 CreditAttribution: Akanksha92 commentedAccording to "https://www.drupal.org/docs/develop/documenting-your-project/readme-temp..." README files should be as per Drupal standard. Updating the File. Please Review
Comment #3
Eitisha CreditAttribution: Eitisha commentedThe patch applied cleanly. But it has some warnings. Please look into it. Attached is the screenshot.
Comment #5
bhanuprakashnani CreditAttribution: bhanuprakashnani at Google Summer of Code commentedPlease review and mention if any more changes are to be made. I have changed it as per the Drupal README standards. Thank you.
Comment #6
daniel.nitsche CreditAttribution: daniel.nitsche at Modules in Depth commentedComment #7
daniel.nitsche CreditAttribution: daniel.nitsche at Modules in Depth commentedThanks for this, because I think the README needs some work, and hasn't been updated in an while.
I've updated the issue summary, because I think the README needs to be rewritten in places, but that is outside the scope of the original issue. Where the text has been modified/updated in a patch, and I believe it needs work, I've mentioned that below.
I see a few issues with the patch in #5:
1. There is a line break after "Administer > Configuration > Search and metadata > URL aliases" which is causing "Delete aliases" to be treated as a quote (example here: https://codepen.io/anon/pen/BxvPLr)
2. This line has been removed: "If you are developing for this module, have a look at pathauto.api.php." -- as per the new issue summary, I think we should avoid a full rewrite for now, and just aim for a restructure.
3. " Navigate to Administration > Extend and enable the Sign for pathauto module and its dependencies." -- I don't think this is necessary based on the guidelines. If we want to keep this, it should read: "Navigate to Administration > Extend and enable the Pathauto module."
4. Rename "Notice" back to "Notices" or come up with a better name (Notes?)
5. "If the module is not shown in the list try deleting the module and try cloning it again. or else try clearing the cache, and then try installing it." -- I think this should be removed as it's not specific to this module. If we want a troubleshooting section, I'd move the last two points from "Notices" in here. We could also rewrite those last two points as questions, and rename the section "FAQs".
6. "For external links, you might want to consider the Path Redirect or Global Redirect modules, which allow you to set forwarding either per item or across the site to your aliased URLs." -- this should be moved to the "Recommend Modules" section
Comment #8
Vidushi Mehta CreditAttribution: Vidushi Mehta at gai Technologies Pvt Ltd commentedAdded a patch according to the #7 above mentioned points with the interdiff.
Comment #9
alonaoneill CreditAttribution: alonaoneill at Hook 42 commentedReviewed the patch for spelling and grammar. Formatting aligns to Drupal documentation standards. Everything looks good. Patch applied.
Marking as RTBCed.
Thank you for working on module!
Comment #10
BerdirIf we're touching this, lets make some more improvements.
The 8.x-1.x part isn't necessary because this is the readme for the 8.x-1.x version.
The functionality of these modules has been merged into redirect.module in D8, so we can drop this.
Most of these haven't maintained this module in a very long time?
Lets keep dave and add me?
Comment #11
shubham.prakash CreditAttribution: shubham.prakash at OpenSense Labs commentedThis patch will fix the mentioned issue.
Comment #12
ravi.shankar CreditAttribution: ravi.shankar at OpenSense Labs commentedComment #13
BerdirThanks, don't forget to post interdiffs to make it easier to review changes.