document rest of D6 perms

Here is the closest page that deals with this issue.

http://drupal.org/node/132202

Since I'm new to documenting in Drupal, I'm not sure of the best approach for this section. Right now it is set up so that all modules and the associated permissions are listed on a single page. This probably makes it easier to scan, but there are a couple problems with this approach.

• size manageability - if every single module listed it's permissions references here, the page would be enormous - like monstrously enormous
• no granularity - developers of new modules will find it more difficult to add their own permissions info to this page.

So, I would like to suggest that we create sub pages for each module. so http://drupal.org/node/132202 would just introduce the section to explain what the page is for, and the book module will provide an alphabetical list of the modules for which this documentation exists. Then each of those pages would list the permissions settings made available by each module. But I want to know what other people think of this. Does it make sense? Some modules only expose one setting. Is it silly to break them out into a separate page?

I've decided to dedicate this page to core modules. This will keep it manageable and contributed modules can add documentation to this section by creating a child page.

There is still a lot of work to complete the documentation of permissions for all core modules. Please add them as you find them or submit your proposed permission descriptions to this issue so that someone else can roll them in.

There are also some comments on the page that need to be pulled into the appropriate areas. I will try to come back and do this soon.

Filter module
filtering the content posted into nodes.

FYI: The page in Issue needs also to be updated as for New Edit Permissions for registered User on D.O.

This is referencing a handbook page. Moving to correct project.

so really, http://drupal.org/node/132202 just should be updated for D7

Maybe. In Drupal 7, there is in-page documentation on what the permissions do, right inside Drupal on the permissions page. So maybe that page is not so necessary for Drupal 7? Also, all the perm names have changed, so it would need to be a separate page for D7.

this does seem a little redundant doesn't it? we also describe a lot of the perms in more detail in the help reference pages...

It is probably helpful to have that page still there for Drupal 6 though... So maybe we should put a note at the top saying something to the effect of "In Drupal 7, the permissions are documented in Drupal itself. blah blah blah" ?

ok, http://drupal.org/node/132202 added a nice little note at the top (and capitalized module names while i was in there) changing title back to d6 and adding novice tag as this would be a nice beginner task.

This wasn't a super priority, but it was the oldest issue tagged with "novice".
I compiled the missing core modules permissions, in alphabetical order, and did some minor edits (capitalization).

I'm not assuming people will actually enter description for all, so if there is no mistakes to the list, I would tend to mark it as fixed, in a few days.

Good work, and thanks for contributing! A few things still need to be fixed on this page, however:

a) I don't think this issue should be marked fixed until all the permissions have at least a short description... but I guess there could be a few whose name is so self-explanatory that they don't need even that? I don't think the page is at that point yet as far as descriptions.

b) The capitalization of permission names is incorrect, I believe -- I don't think they are capitalized in Drupal 6 on the permissions screen? In my opinion, those capital letters should be removed so the permissions match what you see on the permissions screen. On the other hand, I think the paragraphs describing each permission should start with a capital letter as they do in some places but not others. It looks/feels very odd to me when they start with a lower-case letter. Probably they should all start with a verb to be consistent. And they should all end with a period (.).

c) There is also a typo in the header section at the top. The section about d5 has a redundant "Drupal 5":
(In Drupal 5, they are found under User Management » Access Control or URL /admin/user/access[/optional-role-id] in Drupal 5.)

d) Other typos on the page:
it's -> its in administer blocks
setting -> settings in administer blocks
BlogAPI -> Blog API (name of module)

e) The description for "administer permissions" doesn't make any kind of sense to me, and the "administer users" one is also confusing, as well as "change own username" (what is "tin"?).

f) Someone should verify that all of these permissions exist and with the same names (and no additional permissions) in Drupal 5. I suggest noting differences in the line containing the permission name, like this:
administer permissions (Drupal 6 only -- called administer access control in Drupal 5)

g) It looks like there aren't any contrib module pages currently... maybe if there were contrib module permissions in the past that were edited out of the page, someone can find them in the revisions and make child pages?

Hello,
I made the suggested modifications in b), c), d), as well as replacing preexisting descriptions in e). Like many others, I'm not sure I'll be able to make further modifications before going to Chicago, so I'm temporarily removing my name from the assignment.

If other people are jumping in at a later point, like code sprints, here are the remaining points:
a) All the permissions have at least a short description.
f) Someone should verify that all of these permissions exist and with the same names (and no additional permissions) in Drupal 5. (Impress people with your historical knowledge ; ) )
g) If contrib module permissions pages exists, they could be added or reinserted as child pages.

Looks good -- thanks very muhc sylvain_a!!

a) and f) from #15 should be done now.

Just about! I noticed this one missing a description still:

administer content with Blog API

Nice job tdway! Where you there during the sprint in Chicago last friday?

I've pushed this issue a little bit closer to its "fixed" state:
- Added missing description for BlogAPI.
- Removed "Page in progress" paragraph and "incomplete" tag, since all permissions now have a description.

Regarding g), i'm not aware of any other existing documentation regarding contrib modules permissions. There is however a clear note indicating how to proceed if any module maintainer wishes to do so in the future (add a child page).

What this issue now needs is a good overall copy review, in my opinion.

Awesome! Copy/style review ahoy, needed updates:

- The menu paths currently read like:
in Drupal itself on the Permissions page at /admin/people/permissions (<em>Admin > People > Permissions</em>)
and should read like:
in Drupal itself on the Permissions page (<em>Admin > People > Permissions</em> or <code>http://example.com/admin/people/permissions[closing code tag]) (sorry couldn't get the closing tag to show properly...)

- They should also use > instead of » consistently (the » is from people previously copying the breadcrumbs right out of their sites).

- The descriptions should have punctuation at the ends of the sentences even if they're short.

- In the Node module section, instead of [TYPE], I think maybe [content-type] might be a little more friendly?

Here are my edits if you want to review (I made a few small changes, but the above still need to be done) - I also changed the page title (should be sentence case) and the instructed naming convention for contrib modules so the section's titles won't be so heavy. http://drupal.org/node/132202/revisions/view/1396752/1402086

Otherwise, this is totally rad! Once those little tweaks are done, we should mark this all completed. So great to have this finished... though we should probably file another issue when this is done to do the same for D7. ;)

Side note: some of this info might be duplicated in the actual module documentation pages, but some others are very sparse. Considering whether we ought to cross link them somehow (with anchors or at least from this page to the module pages that exist)? They're all at http://drupal.org/documentation/modules/[module-name] if they exist.

I made those style changes

Great -

Anyone agree that we should cross reference these with the module doc pages, as suggested at the end of comment #21?

And also, would anyone be able to file a comparable issue for creating a D7 docs page for this too?

Thanks!

I updated the page to make it a little more consistent and added bold to the sections that state "This permission should only be given to fully trusted users." or "Warning: Give to trusted roles only; this permission has security implications." to hopefully draw attention to them.

Should this be closed?

Yes, I think the page is fine. Thanks!