Problem/Motivation

The UI standard page for Contextual links needs to be updated: https://www.drupal.org/docs/develop/user-interface-standards/contextual-...

Proposed resolution

Rewrite the page and add missing screenshots.
Check whether core modules follow this standard.

Remaining tasks

Task Novice task? Contributor instructions Complete?
How-Why-Examples No Change the order of the text to first say how button should be used, then why, and then follow it up by a good example. Yes
Screenshots Yes Add screenshots if needed. Yes
Summary Yes Add a one sentences summary that's useful here. Yes
API Yes Add the correct link for the Drupal 8 API. Yes
Double check Yes Check several modules whether they use the contextual links this way. Add in a comment which pages you checked. No
Double check issues Yes If you find a module that does not follow this standard: make an issue to fix this. Optional

Comments

ifrik created an issue. See original summary.

ivan berezhnov’s picture

ivan berezhnov commented
Issue tags: +CSKyiv18

Version: 8.5.x-dev » 8.6.x-dev

Drupal 8.5.0-alpha1 will be released the week of January 17, 2018, which means new developments and disruptive changes should now be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

joshmiller’s picture

joshmiller
he/him
Primary language English
Location Indianapolis, Indiana, USA
commented
Issue tags: -Vienna2017 +Nashville2018
msankhala’s picture

msankhala commented

@Ivan What is this CSKYiv18 tag used for. I see you add this tag to many issues. :)

gramie’s picture

gramie commented
Assigned: Unassigned » gramie

I'm working on this at DrupalCon Nashville2018 in the Mentored Sprint. If anyone wants to talk about this, come and talk to me!

gramie’s picture

gramie commented
Assigned: gramie » Unassigned
Status: Active » Needs review

Changed the layout to follow standard of other documentation (how-why-examples)

Added link to Drupal8 API

The recommendation says to avoid using a single task, but this is very common on a standard Drupal installation (for example, by the blocks and views modules), so maybe this should be softened or explained more.

sk33lz’s picture

sk33lz commented
Status: Needs review » Needs work

The screenshot used on this page is a good visual reference, but is low quality and looks blurry. The most recent updates by @gramie look great, but we should update the screenshot before we call this done for better accessibility.

SharraRosichan’s picture

SharraRosichan commented

+Nashville2018 Working on this at a spring - fixed Vertical Tabs.

gramie’s picture

gramie commented

I've changed the screenshot to one from a standard Drupal install. Hope it's clearer.

joshmiller’s picture

joshmiller
he/him
Primary language English
Location Indianapolis, Indiana, USA
commented
Issue summary: View changes

One remaining task to do.

joshmiller’s picture

joshmiller
he/him
Primary language English
Location Indianapolis, Indiana, USA
commented
Issue summary: View changes

Version: 8.6.x-dev » 8.7.x-dev

Drupal 8.6.0-alpha1 will be released the week of July 16, 2018, which means new developments and disruptive changes should now be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.7.x-dev » 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 9.1.x-dev » 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.5.x-dev » 10.1.x-dev

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 10.1.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

quietone’s picture

quietone commented
Status: Needs work » Fixed

The remaining task here is "Check several modules whether they use the contextual links this way. Add in a comment which pages you checked.' Unfortunately, that is not enough detail for me. I did test the contextual links on a fresh install of Drupal 11.x today. I checked all the contextual links on the front page and the one node I created. They all appeared correct to me.

There is at least one issue to fix the display of contextual links, #2983655: Contextual links are not displayed correctly. So, I think it is safe to close this issue as fixed. I am sure someone will correct that if it is wrong.

Status: Fixed » Closed (fixed)

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