Add Display Suite HELP [#2718149]

The release notes for Drupal 8.1.0 indicates an " Improved site administration experience: * Improved admin/help page to be more flexible and list tours on it."

The Help text standard (for core and contrib) gives a detailed account of how to do this the 'drupal way'.

I've been working on this for a few other modules and should be able to make quick work of getting this in for Display Suite, so I've assigned this issue to myself to work on. The way I've done it elsewhere is to implement each aspect (1-4) as a separate patch/issue. We'll see how that approach works here.

Comment	File	Size	Author
#9	Add_Display_Suite_HELP-2718149-9.patch	2.48 KB	dbt102
#3	Adds a nice Help display at :admin:help:ds.png	139.2 KB	dbt102
#3	Adds Display Suite to Help Module Overviews at :admin:help.png	88.93 KB	dbt102
#3	Adds Help Icon at admin:modules.png	33.91 KB	dbt102
#2	Add_Display_Suite_HELP-2718149-2.patch	2.75 KB	dbt102

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

3 May 2016 at 15:39

dbt102 created an issue. See original summary.

Comment #2

dbt102 CreditAttribution: dbt102 commented 3 May 2016 at 17:33

File	Size
Add_Display_Suite_HELP-2718149-2.patch	2.75 KB

Comment #3

dbt102 CreditAttribution: dbt102 commented 3 May 2016 at 17:43

File	Size
Adds Help Icon at admin:modules.png	33.91 KB
Adds Display Suite to Help Module Overviews at :admin:help.png	88.93 KB
Adds a nice Help display at :admin:help:ds.png	139.2 KB

With the following screenshots you can see waht this patch actually will do ...

1. Adds Help Icon at admin:modules

2. Adds Display Suite to Help Module Overviews at :admin:help.png

3. Adds a nice Help display at :admin:help:ds

Comment #4

dbt102 CreditAttribution: dbt102 commented 3 May 2016 at 17:44

Status:

Active

» Needs review

Comment #5

dbt102 CreditAttribution: dbt102 commented 4 May 2016 at 12:22

Assigned:

dbt102

» Unassigned

Unassigning the task from myself so others won't shy away from testing this patch

Comment #6

aspilicious CreditAttribution: aspilicious commented 4 May 2016 at 14:50

This is a good start, I would love some more input from others.

I would like to remove any references to "previous" versions. As they are not relevant for D8.
For example:

+ $output .= '
' . t('Using Display Suite we no longer implement hook_ds_field_info() and return an array of field information per entity type, but create a plugin class with data straight in its annotation and the relevant logic inside its methods.') . '

';

Comment #7

dbt102 CreditAttribution: dbt102 commented 4 May 2016 at 16:18

@aspilicious thanks for the comment.

I'll remove that reference to "previous" versions ...

However, it kind of brings up a larger issue, which it how to update the DS Community Documentation. This is the same link which we reference in the HELP patch.

NOTE: if you go to that link you'll notice that the Drupal Version listed is for D6 & 7 ... AND there are 20+ pages of detailed documentation that is DS related ... all of which needs updated.

IMO: Cleanest way is to leave the D6 & 7 pages as is, and start over by creating new D8 pages. Then, the "About DS in D8" is linked to from DS HELP.

ref: --> #2718939: Update DS Documentation for D8

Comment #8

dbt102 CreditAttribution: dbt102 commented 4 May 2016 at 17:22

Assigned:

Unassigned

» dbt102

So I got a started on the DS for D8 About page, and will change the reference made in patch #2.

I'll try and push the about Documentation along today, and hopefully roll a new patch by tomorrow AM.

Assigning this task back to myself to do it.

Comment #9

dbt102 CreditAttribution: dbt102 commented 5 May 2016 at 01:41

File	Size
Add_Display_Suite_HELP-2718149-9.patch	2.48 KB

4 files were hidden/shown/deleted

File	Size
Add_Display_Suite_HELP-2718149-2.patch	2.75 KB
Adds Help Icon at admin:modules.png	33.91 KB
Adds Display Suite to Help Module Overviews at :admin:help.png	88.93 KB
Adds a nice Help display at :admin:help:ds.png	139.2 KB