Extend documentation

Created on 24 October 2023, about 1 year ago
Updated 26 October 2023, about 1 year ago

Please provide some more information how to configure this

In the Readme the first step is "On the order form display enable the checkout form mode.". I am unsure if this refers to /admin/commerce/config/order-types/default/edit/display as there is no Checkout display type listed (only default/user). This is on Drupal 10.1 with Commerce 2.36.
It would be great if you could extend the docs to better explain how this can be enabled and where to configure the fields etc.

🐛 Bug report
Status

Fixed

Version

1.0

Component

Documentation

Created by

🇩🇪Germany gruberroland

Live updates comments and jobs are added and updated live.
  • Novice

    It would make a good project for someone who is new to the Drupal contribution process. It's preferred over Newbie.

Sign in to follow issues

Comments & Activities

  • Issue created by @gruberroland
  • 🇩🇪Germany Anybody Porta Westfalica

    Thanks, you're totally right. Could you improve that perhaps?

    It doesn't need technical knowledge and is a community job. Thank you

  • 🇩🇪Germany gruberroland

    Sure, will be happy to provide an update to the Readme. Can you point me to the admin page for this first step "On the order form display enable the checkout form mode."? I was not able to get the module working yet.

  • 🇩🇪Germany gruberroland

    Finally, I got it working. Can you add the following to the project description? Issue 3133317 can be closed then, too.

    Requirements:
    Please make sure that you have activated the "Fields UI" extension.

    Configuration:
    Open your order type in commerce configuration and switch to tab "Manage fields" (e.g. /admin/commerce/config/order-types/default/edit/fields).
    Now add the fields that you wish to add to your checkout process. E.g. add a "Text (plain, long)" field to allow users to provide order comments.
    You can create multiple fields but they will appear all at one defined location in the checkout process later.

    Next the display of the fields is configured. Switch to tab "Manage form display" (e.g. /admin/commerce/config/order-types/default/edit/form-display).
    Here activate the custom display settings for "Checkout" at the end of the page. Then save.
    Now you can edit the "Checkout" display settings (e.g. /admin/commerce/config/order-types/default/edit/form-display/checkout).
    Here disable all fields except your new fields.

    Finally, you can specify where the new fields should be displayed. This is on the checkout flow configuration page (e.g. /admin/commerce/config/checkout-flows/manage/default).
    Move the pane "Order fields: Checkout" to the right section, e.g. "Review".

    Now you should see your new fields during the checkout process.

  • 🇩🇪Germany Anybody Porta Westfalica

    Thanks @gruberroland! Sorry I wasn't able to reply earlier.

    Please make sure that you have activated the "Fields UI" extension.

    What's the reason for that? We should add a dependency, if the module isn't working without it. Is that the case? Did you run into an issue?

  • 🇩🇪Germany gruberroland

    If you can add a dependency then even better. The Fields UI module provides the GUI to manage fields. Without it there is no tab to manage any fields.

  • Status changed to Needs review about 1 year ago
  • 🇩🇪Germany Anybody Porta Westfalica

    @gruberroland please review :)

  • Open in Jenkins → Open on Drupal.org →
    Core: 9.5.x + Environment: PHP 7.4 & MySQL 5.7
    last update about 1 year ago
    7 pass
  • @anybody opened merge request.
  • 🇩🇪Germany gruberroland

    Thanks, looks good! :)

  • 🇩🇪Germany Anybody Porta Westfalica

    Could you set the status to RTBC then please, so I may merge it?

  • Status changed to RTBC about 1 year ago
  • Open in Jenkins → Open on Drupal.org →
    Core: 9.5.x + Environment: PHP 7.4 & MySQL 5.7
    last update about 1 year ago
    7 pass
    • Anybody committed 66c6f4f9 on 8.x-1.x
      Issue #3396276 by Anybody, gruberroland: Extend documentation
      
  • Status changed to Fixed about 1 year ago
  • 🇩🇪Germany Anybody Porta Westfalica

    Thanks! Merged and credited! :)

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

Production build 0.71.5 2024