I finally got the chance to look this module over. This is a heck of a job you've done!!

Some random feedback. Sorry to abuse the issue queue for this... I plan to submit patches for at least some of this later, just want to keep track of my notes publicly and get your feedback.

1. I would ditch the functionality that actually "does stuff" to the database. This is a documentation module, which should be non-destructive, imo.

2. If you choose to keep it (or maybe either way), I would suggest adding an "Operations" column to the right of the table, which could ops such as both "Delete these orphan blocks" and "Run cron." That would also help keep the text from running into one another on some of the entries.

3. I'd add a heading for "PHP" and "Web server" to separate it from "Drupal" info.

4. Add a link somewhere on admin/settings/sitedoc to admin/build/sitedoc (and vice-versa).

5. More in-line help as to what some of this stuff means.

6. I don't know that it makes sense to output constantly changing and HUGE amounts of content info, like the titles of all the nodes and all the path aliases. I realize this is togglable, I just wonder if anyone would ever need such a thing, and if not it makes sense to take it out and simplify the code (there's a lot of code :)).

7. Code doesn't conform to coding standards; I'd run it through coder.module.

8. I'd love to be able to export a "printer-friendly" version of this. Currently it displays with all my blocks and menus and stuff on the page. I know a halfway decent theme will include a print.css, but not all of them do.

9. When listing the users in a role, it should link to their user profile, rather than (or maybe in addition to) putting their user id next to them.

10. Maybe rename "Boxes" to "Custom blocks" so people know to what that's referring.

11. I'm not sure that it's worth totally duplicating the admin/build/modules screen; for instance, we probably don't need dependency information there.

12. I haven't really looked under the hood yet, but one other thing I really want to do is make this module "hook-able" so that I could, for instance, write an .inc file to export OG information, or Actions/Workflow information... these wouldn't make sense for sites that don't have those modules, but would be very valuable for those that do.

Thanks very much, Nancy!

Comments

nancydru’s picture

nancydru
she/her/hers
Primary language English
Location Boston
commented
Assigned: Unassigned » nancydru

1) I went ahead and added the "doing stuff" (all optional) for those who are too timid to go into phpMyAdmin and fix them by hand. And, in some cases, the sheer volume of the fixes would probably create problems if done by hand. I believe I have all those function defaulted to off.

2) Done, except "delete orphan blocks" still runs as designed. I'm still open to further discussion on this, but hate to have to reproduce the code to do something that would have already been done the way it is now.

Now, as I was adding the "op" column, it struck me that most of the basic section stuff could have "go to setting" added to it. Any thoughts on this?

3) Done.

4) Done. And it turns out to be a real boon to using the module! Thanks for the idea.

5) I need some examples for what you mean. I'm certainly open to this, it's just that I'm too close to the module now to see what's missing.

6) The aliases section is one that I envisioned that would be only used once in a blue moon to see if any errors had been introduced. But it does catch some problems if they exist, as they did on a few of my sites.

7) I did run it through Coder and got a clean report. I made many changes based on its review (ask, Doug, I had to ask him several questions, and even generated a forum post on switching from objects to arrays).

8) I need to read up on print css files; this is something I've never done before. Please add this as a feature request.

9) Done, although I don't see a particular value to this, but it was trivial.

10) Done.

11) Darn, I was so happy to get that working! It's still there for now. I kind of like seeing the dependencies as a way of saying "This is enabled because..."

12) I don't have OG, so I'm not sure what this means. As for hooks, I have asked in several places for help in figuring out what data hook_sitedoc might have returned. I have some ideas, but can't really decide if the value is really significant. As for Actions, I may be getting into that for a new site I'm designing.

The changes that I have made have already been committed and should be available momentarily (as we're approaching roll time now). The others are open for further discussion. I will also be downloading the latest Coder in the morning to get the nwe bad news.

greggles’s picture

greggles
he/him
Primary language English
Location Denver, Colorado, USA
commented

I was redirected here by an issue to remove the optimize function (because optimize is redundant with other modules that already do that).

I guess if you plan to keep it (it wasn't clear to me if you were going to keep it or not) then I request that you document it on the project home page.

nancydru’s picture

nancydru
she/her/hers
Primary language English
Location Boston
commented

It was already on the documentation page, but I also added a statement on the project page.

nancydru’s picture

nancydru
she/her/hers
Primary language English
Location Boston
commented
Status: Active » Closed (fixed)

(#12) When there are some suggestions on what hook_sitedoc should look like, please open a new feature request.