The coding standards at http://drupal.org/coding-standards are manually generated from a CVS document. I understand that part of the reason this is in CVS is so that people who check out the entire repo would have a copy locally. Well, with the changes to how we do releases and such I dare sy that there are quite a bit fewer doing a full checkout. I don't think that is a good reason to make it a total PITA to update that page. It isn't as simple as updating the CVS, but then you have to find one of the, what 3, people that can manually update it from the server.

I propose to make it a regular handbook page and restrict edit access to site maintainers so that we can keep it under tight control but ease the update process.

Comments

gpk’s picture

gpk commented

+1 and bump. The current "system" is inhibiting keeping the page up-to-date. I know of at least one update (#293799: A couple of fixes need on coding standards page) needed to the page, it's been languishing in the webmasters queue for 2 months. I'd have opened another/added to that one but what's the point if it's not going to be acted on..

I do also notice a new Edit tab on coding-standards (for me it returns an empty form elements) so maybe there's been some progress on this ...

scoutbaker’s picture

scoutbaker commented

Another +1.

I found it less-than-helpful to be looking at the coding standards page, trying to suggest or create patches based on that information, and then being blasted since the page was outdated and no one had bothered to update the page from the full distro.

Wolfflow’s picture

Wolfflow commented

+1

I understand just now that "Coding Standards" is a very important aspect of building Sites and of course learn to manage Drupal and all involved with it. I just started to take care of focusing on that and know more about and have doc that let me study this.

add1sun’s picture

add1sun commented
Project: Documentation » Drupal.org site moderators
Component: Other documentation issues » Other

Going to move this to webmasters to feedback and, if there are no objections, I'll just do it.

I suppose this means that we need to do several things:
- Remove the page being generated in drupalorg.module
- Update the CVS doc to point to the handbook page for the latest info

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
commented

No objections. DO IT. :)

kbahey’s picture

kbahey commented
Status: Active » Needs work

This is node 318. I have committed code to the drupalorg module set to not treat it as a special case.

Someone has to refresh d.o from HEAD for that module, then others can edit it as a normal node.

Setting this to CNW until the above two actions are taken.

add1sun’s picture

add1sun commented
Project: Drupal.org site moderators » Drupal.org infrastructure
Status: Needs work » Active

OK, I updated the handbook page and I left a note in the CVS version to look at the handbook from now on. The only problem is that I can't figure out where the coded page is being generated. I couldn't find it anywhere in the drupalorg module family. I'm moving this to infra so someone who knows and has the powah can remove the coded output as it is no longer necessary.

add1sun’s picture

add1sun commented
Status: Active » Needs work

oh, heh. I didn't realize someone else was working on this. No wonder I was confused. :-p

kbahey’s picture

kbahey commented

Addi, hunt down killes or dww in IRC, and make them update the module, then you can edit node 318 as much as you like.

dww’s picture

dww
we/he/they
commented
Status: Needs work » Fixed

Reviewed the diff, and updated handbook.module on d.o to revision 1.11. http://drupal.org/coding-standards seems to be working again as a normal handbook page. Thanks, all.

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for two weeks with no activity.