- Issue created by @caesius
- πͺπΈSpain marcoscano Barcelona, Spain
Thanks for pointing this out. True, the text on the project page is likely inherited from when the project was just an idea to expand what core's
file_usage
does... :)Would you be up for creating a first pass at refactoring the page + readme file?
Thanks!
- πΊπΈUnited States caesius
caesius β changed the visibility of the branch 8.x-2.x to hidden.
- πΊπΈUnited States caesius
I created an MR to move README.txt to README.md (so as to support hyperlinks) and added a blurb at the top that I think could be added to the project page to make the module more "discoverable."
Meanwhile, the project page could probably be trimmed down to remove the "How it works" section. If someone gets stuck and needs more specific instructions or specifications they can follow the link to the README (which should be updated to .md instead of .txt on the project page) -- but my experience with the module was that I didn't need to thoroughly read the project page to understand how to configure it; it was immediately intuitive.
I'm not a fan of the bulleted list of "tracking methods" but I'm not sure if removing it would help or harm SEO when trying to find a "node usage module" or the like. My hunch though is that spamming the word "entity" so many times would make a search engine assume that the module is wholly unrelated to nodes, taxonomies, etc., and the list is way more specific than what I think most devs would use the module for, so it can probably just be preserved in the README.
-
marcoscano β
committed 38a9f02e on 8.x-2.x authored by
caesius β
Issue #3514169 by caesius, marcoscano: Module discoverability / SEO
-
marcoscano β
committed 38a9f02e on 8.x-2.x authored by
caesius β
- πͺπΈSpain marcoscano Barcelona, Spain
Thanks for contributing!
I have merged the PR, and tweaked the project page to include some end-user scenarios that include some of the terms you mentioned above.
I still think the relationship methods list is important since that may be very relevant to developers reading the project page, so they can know the extent of the possibilities of the module.Thanks again!