geerlingguy's doing a great job of adding these things as fast as they come in. But it'd be good to document the process so that others on the team can replicate the same steps.

Comments

sun’s picture

Additionally, a lot of details and decisions seem to be covered in each individual whitelisting request/issue.

Starting with the exact license(s) of a library (at the time of whitelisting), and partially also involving other details.

It would be a good idea to document these details per library (i.e., on or attached to the whitelist node, not in an issue deeply buried somewhere on d.o)

Sorry for mentioning this here; somewhat off-topic.

geerlingguy’s picture

Please see #783186-17: Packaging: document whitelist. (I've started some docs, but don't know where to put them...).

I think it would definitely be helpful if we included either a simple select field on each whitelist node so one could tag it with the license attached, or have a link to the license (something). For the time being, whenever I create the node, I add a reference to the issue # in the log message. (Or, at a minimum, a public reference to the issue that was used to request the whitelisting).

webchick’s picture

I'd say go ahead and add it as a sub-page under http://drupal.org/drupalorg-site-maintainers-guide, and link to it from the project page.

The comment at #1 sounds like a good feature request for http://drupal.org/project/drupalorg.

geerlingguy’s picture

Status: Active » Needs review

Posted initial document to http://drupal.org/node/1404994, and marked as 'needs copy/style review.'

avpaderno’s picture

We should add a link to a documentation page that reports the syntax for the regular expression used, and then report what normally is being used. I assume the syntax for the regular expressions is the one used from functions such as preg_match().

The general documentation is useful for specific cases, such as when the directories are contained in a directory that contains, for example, demo code we want to exclude; in that case, there could be the need to consider only the directories with a name starting with a number, to avoid directories like "demo," "examples," "dependencies."

geerlingguy’s picture

The regex is simply Perl-style syntax.

Also, regarding the strictness of regex w/r/t example/demo/dependency directories... typically libraries are only available as .gz, tar.gz, or .zip packages containing all the relevant code (sometimes including examples and demo code), but there's no way to prevent individual directories from within those archives from being included.

That's why over in #1360456: Finalize the criteria and process for the whitelist for external dependencies packaged with Drupal distributions a 10MB library size limit was suggested... there are a few libraries that include full movie files and audio files in their examples, meaning they're well over 20MB! For now, those libraries will simply not be allowed.

dww’s picture

Status: Needs review » Fixed
Issue tags: +drupal.org distribution blockers

See #1406902: Provide taxonomy or field for recording packaging whitelist license details for #1. That is indeed a good idea that might have been lost in the original discussions at #779452: Whitelist for external dependencies. But yeah, easily being able to define another field/vocabulary on these whitelist nodes for stuff like this is exactly why I wanted to use nodes for these in the first place instead of hard-coding this stuff.

http://drupal.org/node/1404994 looks like a great start. The only things I'd change for now:
- We should probably link directly to the whitelist project page, too.
- We should link to the PHP regexp docs when explaining the syntax of those.

Otherwise, looks perfect (other than the lack of criteria to link to, but that's a separate question).

I just made those changes and a few other minor fixes:

http://drupal.org/node/1404994/revisions/view/1839020/1841552

Calling this fixed. Yay!

Thanks!
-Derek

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