Link to sandbox: http://drupal.org/sandbox/venutip/1090672
Original CVS application: http://drupal.org/node/997068
The Inspector module provides a report that you can run just before you launch a site to make sure that you've got all your Drupal ducks in a row. Among other things, it checks that:
- Caching and JS / CSS aggregation are turned on
- You have pathauto installed with best practice settings
- You have path_redirect installed with best practice settings
- Cron has been run recently
- You've got spam protection on your webforms
- Submission addresses of your webforms don't contain any internal or testing domains
- You don't have any published nodes that contain "dummy" text (like lorem ipsum)
- You've installed a WYSIWYG and assigned it to at least one other input format
- You have at least one user with an administrator role
... and other stuff you want to check before making a site go live.
Some of the reports are configurable, and new reports can be added using hooks.
| Comment | File | Size | Author |
|---|---|---|---|
| #14 | inspector-1090684-14.patch | 36.44 KB | tim.plunkett |
Comments
Comment #1
avpadernoComment #2
joachim commentedInteresting idea.
Have you checked for existing modules that provide this? It does sound rather familiar to me.
Also, the name 'Inspector' doesn't really convey what this does. Launch checklist would be better -- and I'm a feeling I've seen a module named along those lines.
Comment #3
venutip commentedHi joachim,
There are some similar-looking modules out there, but none of them do what this module does.
Regarding the name, something like "Launch Checklist" would not be inappropriate, but since this module does not provide a checklist in the style of the above-mentioned modules, we don't want to create that association – Inspector is more than a web-based checklist.
Comment #4
venutip commentedChanging to critical as it has been months since anybody looked at this.
Comment #5
avpadernoIt has been less than a month, actually. There are no applications that are more important than others.
Comment #6
venutip commentedPerhaps I should have been more specific: before your comment, the last time somebody other than myself posted a comment on this module was March 30, 2011 at 5:36pm, which is nearly three months.
Even if my own comments count toward the time, the status should have been changed to "major", since my comment was over two weeks ago. Either way it will be "critical" in four days.
Comment #7
avpadernoRaising the priority doesn't have any effect; if you change it to critical, the application will not reviewed first. The priority is not used for tasks, and it is not used in this queue.
The priority description page reports the following text:
Comment #8
venutip commentedAre you saying this documentation is incorrect?
That comes from the page, "Application review process for Full Projects; what to expect", http://drupal.org/node/539608
Comment #9
venutip commentedRight then. Changing priority back to critical according to the new priority guidelines.
Comment #10
joachim commentedFrankly, I read down that list and I don't see a reason for more than one module. Maybe two at a push if one is security focussed.
Which one is most popular? Which one has the best code (for a variety of definitions of 'best')?
I'd rather see efforts towards consolidating the existing landscape than one more module in it that will confuse users.
Comment #11
jthorson commentedAs per the the new project application priority guidelines, the application's priority should be set back to normal once a reviewer responds to the application and the application review process has continued.
Comment #12
joachim commentedOut of the above list, let's discount Security Review, Security, and SEO Checklist as too specialized.
That leaves QA Checklist and Checklist. Could one of those be expanded with the features here? Would co-maintainership be a possibility? If they are abandoned, could they be adopted?
Comment #13
venutip commentedHi joachim,
While they appear similar on the surface, Inspector and Checklist address different use cases. Inspector has a fairly narrow audience – it is aimed squarely at site builders who are moving a Drupal site into production. Checklist is about creating custom lists of tasks; the tasks might be about the setup and configuration of your Drupal site, but they might also be about content, or SEO, or anything else.
Further, Inspector is all about programmatically inspecting the state of your Drupal installation and reporting its findings. Inspector is more like Drupal's status report, in that the only way to "complete" an item, is to do it. There is no checkbox because that would be cheating :-) Checklist, on the other hand, doesn't (and can't) check to see if you have really completed an item before marking it as such. If you check an item off, Checklist considers it done.
I think that integration with the Checklist module would be a cool feature for a future version of Inspector – it might be an easy way to mark an issue you don't plan on fixing as acknowledged. But I don't think it makes sense to try and combine the two, as they address different use cases.
Much of the same can be said for QA Checklist. In fact, given what QA Checklist is trying to achieve, it would make more sense for QA Checklist to switch to a report-based architecture like Inspector has. For instance, QA Checklist has a checkbox for "Enable caching". It doesn't tell you whether you've enabled caching or not, and you can mark it as done even if caching isn't enabled. In my mind, that isn't very useful.
I understand the desire to combine efforts where possible, and to resist the urge to create Yet Another X Module. But I don't think it makes sense to try and integrate Inspector with either of these modules, or with any other module that currently exists.
Comment #14
tim.plunkett@venutip, I would recommend trying to take over the QA Checklist module. I think it has a clearer name, I thought this was something like Devel Themer, or Firebug's inspector.
Plus, it reuses a namespace, instead of yet another similar module.
You can follow the Abandoned Module process and close your application, if you choose. Plus, I will tell you, it is an easier process.
Either way, here is a coding standards patch to help you out.
Comment #15
ethanw commentedHi @tim.plunkett, et. al.
I've worked with @venutip on this module a bit and have used it on a number of projects, sometimes as a pre-launch tool, but often for diagnostic reporting when to evaluate work done by other developers, provide quotes for site overhauls, and other "report" use cases that aren't covered by the particular focus of the QA Checklist module or that namespace.
Because there are a number of non-QA usecases, I think that the fact that this module aims to be a reporting and investigation tool, and not just a QA checklist tool, distinguishes it from other currently available modules. There are certainly a number of points of potential integration with modules like QA Checklist, and we could work to expose test routines and results a bit more through an API to allow other modules to take advantage of it, but I don't think they are the same thing.
That said, I think that the question about whether Inspector is a sufficiently descriptive name is a good one.
@venutip, perhaps we can look into this as part of a D7 port of the module?
Comment #16
venutip commentedApplied tim.plunkett's coding standards patch (thanks!)
Comment #17
mlncn commentedModule is verified as solid, venutip is treating it as a full project already (applying patches etc). Technically, we currently vet project maintainers, not the projects themselves, and given the six-week approval queue we cannot afford to make overlap in the could-merge-together-in-the-future-but-clearly-have-different-cases-now category hold up a review.
This application has been in gestation for 10 and a half months. Lets move on to some that really need review.
Comment #18
mlncn commentedvenutip, you are now a vetted user, and can promote this to full project if you choose. Please take a good look at the best namespace, and ensure that becoming a part or a submodule or a 2.x branch of another module isn't the best route. I look forward to your continued improvement of this module which i expect to use in D7!