Problem/Motivation

A follow-up of #3546356: Update documentation.

Update screenshots

Some screenshots:

  • are old and don't represent the current state
  • have low resolution and look "dirty"
  • don't scale, especially in "Available islands"

So let's update them. With the new Drupal Core admin theme to be ready for next release.

Installation

The installation page can be a bit scary for people willing to discover the module:

  • it describes the full installation of a Drupal with ddev
  • it tells some recommended modules are required (UI Patterns Library, UI Styles...)
  • it tells about UI Suite Bootstrap, giving the feeling the module is related to Bootstrap
  • it described how to create a Page Layout and an Entity Display
  • "Troubleshooting" is still mentioning display_builder_dev_tools which is not targeting our users >> move to FAQ and tell about drush command.

So it gives the feeling of a complicated install process.

Under the hood

  • Move to specific section inside "Contibuting" so we keep the "Using Display Builder" pages only for user documentation
  • Make sure Internals overview graph are all with white background. Transparent backgrounds don't look good on dark mode

Add a word about permanent storage in the FAQ.

Entity View Override

Update according to changes from #3562686: Entity view override enhancements.

Configuring

Maybe a little rewording about Island types (View, Menu, Contextual...).

Instances overview

There is nothing about this page added late in beta1, let's add something.

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

pdureau created an issue. See original summary.

pdureau’s picture

Issue summary: View changes
pdureau’s picture

Issue summary: View changes

pdureau’s picture

Assigned: pdureau » mogtofu33
Status: Active » Needs review

Hi Jean,

Here is a proposal for documentation update.

I did everything from ticket description except:

  • "Make sure Internals overview graph are all with white background. Transparent backgrounds don't look good on dark mode" >> the graph will change a lot the next weeks, so it is useless to update them now
  • "Troubleshooting" is still mentioning display_builder_dev_tools which is not targeting our users >> move to FAQ and tell about drush command" > $ drush entity:delete display_builder_instance doesn't do anything for me ;)

mogtofu33’s picture

Assigned: mogtofu33 » Unassigned
Status: Needs review » Fixed

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

Status: Fixed » Closed (fixed)

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