Problem/Motivation

Because they're used for namespacing, most or all features developers will want to first create a bundle before generating features. However, currently, the first screen to appear on initial install is the feature generation one, with "Default" selected for "Bundle". Users may proceed to generate features and only later discover that they should first have created one or more bundles.

Even if they first look around and bring up the admin/config/development/features/bundle screen, there's not a lot to go on in order to understand what a bundle is and why you would create one.

Proposed resolution

If no bundles have yet been created, at admin/config/development/features generate a message. Draft:

You have not yet created any bundles. Before generating features, you may wish to [link]create a bundle[/link] to group your features within.

(Moved to #2653166: Provide message if no custom bundle created.)

Amend help text at admin/config/development/features/bundle. Draft:

Bundles are used to collect together groups of features. A bundle provides a shared namespace for all features included in it, which prevents conflicts and helps distinguish your features from those produced for other purposes. Common uses of bundles include:

  • Custom features for use on a particular site.
  • The features of a given distribution.

Use the form below to manage bundles. Each bundle comes with a set of assignment methods. By configuring and ordering the assignment methods, you can set the defaults for what does and doesn't get packaged into features for your bundle. Use the Bundle select to choose which bundle to edit, or chose --New-- to create a new bundle. The Default bundle does not include a namespace and cannot be deleted.

Remaining tasks

User interface changes

API changes

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

mpotter’s picture

I'm not sure I want to force people to use bundles. It's really easy to move a feature into a bundle at a later time (edit the feature, select the bundle, export). So I'm not sure we need to change the first screen. I'm not a fan of putting a ton of help text onto the screen. That's the kind of stuff that really belongs in the Readme file.

So maybe this issue could create a patch for adding help to the Readme?

colan’s picture

I like the original plan. I don't see the problem with having the information upfront. (Aside: The text looks good to me.)

I don't know if I speak for everyone else, but I only look at READMEs if the usage isn't self-explanatory. Actually, I'd rather do away with READMEs in general in favour of UIs that provide all of the necessary information.

nedjo’s picture

Issue summary: View changes
Status: Active » Needs review
FileSize
2.96 KB

Attached patch generates a message if there are no custom bundles and adds the help text.

nedjo’s picture

Issue summary: View changes

Removing company attribution.

nedjo’s picture

Issue summary: View changes

Removing company attribution.

nedjo’s picture

Status: Needs review » Needs work

On second thought, the message should go in a distinct issue, because it should have a test and shouldn't hold up the help text improvement.

nedjo’s picture

Issue summary: View changes
Status: Needs work » Needs review
Related issues: +#2653166: Provide message if no custom bundle created
FileSize
1.72 KB

Moved part of this to #2653166: Provide message if no custom bundle created. Patch is now limited to adding help text.

  • nedjo committed f572ef5 on 8.x-3.x
    Issue #2490818 by nedjo: Add help to clarify purpose and usage of...
nedjo’s picture

nedjo’s picture

Status: Needs review » Fixed

Status: Fixed » Closed (fixed)

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