drupalcommerce / commerce-docs Goto Github PK

Based on tag "commerce_order_summary"

Hi on admin/commerce/config/currency/add I need to guess what is the currency code.
Not select list is shown.
Why?
Thanks

When trying to create new store using the builtin drupal commerce
..\vendor\drupal\console\bin\drupal commerce:create:store
I get the error below
'..\vendor\drupal\console\bin\drupal' is not recognized as an internal or external command, operable program or batch file.

Following https://www.drupal.org/node/2859533#, we should have a page that shows how to customize the order receipt and advanced usages like this.

I think it would be great to give people an easy start with a video introduction.

https://www.youtube.com/watch?v=D9nBCP_tPlQ
https://www.youtube.com/watch?v=BmFFPozHKFU
https://www.youtube.com/watch?v=EQxA3VYal54

The page @ https://drupalcommerce.org/contribute should be updated with this repo for documentation and ways to support.

I killed the bundled RTD Theme JavaScript to stop some of the menu navigation behavior. Doing this broke the mobile slide out navigation.

We need an overview page for our payments section.

http://docs.drupalcommerce.org/v2/payments/index.html

• discuss onsite, offsite ability
• call out major payment gateways

"The default values are based on opensource 3rd party that has the best coverage of all {...}" -- missing a word. Should be "based on an opensource..."

The pics in address and zone have different admin menu orientation. Maybe should be the same

      $form['recaptcha'] = [
        '#type' => 'inline_template',
        '#template' => '<div class="g-recaptcha clearfix" style="clear: both;" data-sitekey="{{ google_recaptcha_public_key }}"></div>',
        '#context' => [
          'google_recaptcha_public_key' => Settings::get('google_recaptcha_public_key', ''),
        ],
        '#weight' => 100,
      ];

then

      try {
        $result = \Drupal::httpClient()->post('https://www.google.com/recaptcha/api/siteverify', [
          'form_params' => [
            'secret' => Settings::get('google_recaptcha_private_key', ''),
            'response' => $_POST['g-recaptcha-response'],
            'remoteip' => \Drupal::request()->getClientIp(),
          ],
        ]);
        $result = Json::decode($result->getBody()->getContents());
        if (!$result['success']) {
          $form_state->setErrorByName('recaptcha', $this->t('Error validating you are not a robot.'));
        }
      }
      catch (\Exception $e) {
        $form_state->setErrorByName('recaptcha', $this->t('Error validating you are not a robot.'));
      }

• Change the names to Product Attribute, Product Attribute Value (It sounds more clear, plus it's consistent with product variation (VS just variation))
• Remove * not fieldable from Attribute. Attributes are config entities and can be extended using the third party settings API
• Add examples on top of each box: Color -> Red -> Red DrupalCon T-shirt -> DrupalCon T-shirt
• Add Label & Weight to Attribute values

Work to be pushed to #19

"The branch name should contain a brief summary of the issue and its id, e.g 2276369-fix-product-form-notice:" -- swap the order of id and issue to match the branch name: "brief summary of its id and the issue"

"git push -f fork 2276369-fix-product-form-notice" -- maybe mention why you have to add the "-f" flag for this command and no the previous push

Your forked repository and the original one (called origin) will eventually out of sync. -- missing a word before "out of sync". change to "eventually {get|become} out of sync"

"The current state is stored in a StateItem field. A field setting specifies the used workflow, or a value callback that allows the workflow to be resolved at runtime (checkout workflow based on the used plugin, etc. A validator is provided that ensures that the specified state is valid (exists in the workflow and is in the allowed transitions)." -- missing a closing parenthesis somewhere... have and extra opening one

RE: #19

Ryan says...

• Change the entity relationship diagram to the below.
• Make an introduction before skipping to an example; (and I’d just make it clearly marked an example, not ask someone to imagine). Like a basic definition; “Every product has one or more variations." ... “In the event that a product has more than one variation, each variation is differentiated by some aspect of the product, whether it’s the product’s color, size, fabric, etc."

[Product type]      --|--       [Product variation type]
  T-shirt                           T-shirt variations
  (fields)                              (fields)

    ||                                    ||
    \/                                    \/
                          /
[Product]           --|--<-      [Product variations]
  DrupalCon T-shirt       \         Red, Green, Blue
  (fields)                          (fields)

• We can assume that the user (full) name is usable as the billing profile name (default on the create form), but can't assume the opposite
• Therefore we can't allow finding a user by billing profile in Commerce core, by default. That stays in contrib
• However, there should be a solution that: 1) adds a name field to the user 2) alters the user display name 3) alters the autocomplete (search by name, username, email)

The https://www.drupal.org/project/name module is close and could be documented on implementing this.

The goal here is to end up with a high-level outline of what the structure of Drupal 8 Commerce API documentation should look like. That will enable developers to fill in the details in a structured way (as opposed to the mess that is http://www.drupalcontrib.org/api/search/8/commerce?page=1).

• Commerce classes
  • Working with products
    • Loading products
      • List out methods for loading
    • Creating products
    • Updating products
    • Deleting products
    • (additional methods)
  • Working with carts
  • Working with orders
  • Working with shipping
• API changes from Commerce 7 to Commerce 8 (should include all of above with old vs new)

Regarding PR #19

• Remove or rework the intro to describe a "normal" use case
• Remove or rework the fieldable entity section to reduce wordiness and increase clarity
• Reword phrases like "Often this is a very obvious designation falling into the category of a differentiation" to be more basic, 4th grade english

Example intro by Bojan:

Imagine you need to sell a DrupalCon T-Shirt. This T-Shirt comes in different sizes and colors. Each combination of size and color has its own SKU, used to track the remaining amount of each kind of shirt

Example of furthering the analogy while describing the entity relationships by Bojan:

Color and Size are product attributes. Blue and small are product attribute values, belonging to the mentioned attributes. The combination of attribute values (with a SKU and a price) is called a product variation. These variations are grouped inside a product.

The work will be reflected in #19

We need a page that discusses the merchandising capabilities of Drupal Commerce 2.

• New, powerful, pricing rules (different from Commerce 1), which are called "Promotions" that handle discounts and coupons
• Ask Bojan / Matt / Josh / Commerce channel on slack if there is more that could be addressed in this section

Document the different formatters.

Plain: 100.00 USD
Default $100.00 with options
Calculated: $100.00, but based on resolved price.

The address format UI no longer exists, so half of the address docs page is no longer valid.

At the MidCamp sprints I noticed we could use a documentation guide on how to contribute to our documentation (META META)

Things:

• Point out each page has an "Edit this page" link at top
• State that they should have a GitHub account
• Show how to edit within GitHub, that it will fork and open PR, how to finalize the creation of PR (it's a three step process.)
• Provide links to ReST basics
• State that images cannot be uploaded from main repo
  • Check if images can be uploaded in their own fork from the UI
  • State they'll have to clone locally and edit to change images / update them
• Verify contributors can add new pages via the UI
• State heavy additions might be best done by cloning down the repository

• Requirement of Swiftmailer
• Where the Twig file is
• How to setup Mailhog for debugging?

http://docs.drupalcommerce.org/v2/payments/available-payment-gateways.html

This list is quite out of date. Recommend we update it with the following (and maybe link this doc?):

https://docs.google.com/spreadsheets/d/18D9RF6DUoLN1zeeV2aGRW_-QmpHA7eNP56ES8djBRRk/edit#gid=1454227332

We need a page created for how to contribute to Drupal Commerce documentation.

We want it to look and read like the contributing page in Getting Started, but for the documentation side of things.

geerlingguy/drupal-vm#1161

You need to add bcmath

http://docs.drupalcommerce.org/v2/orders/order-processing.html

We should have screenshots and show an example order of going from Cart -> Pending -> Completed.

When will be available commerce 2 complete documentation of following topics

1. Catalog and product pages
2. Product merchandising
3. Configuring checkout
4. Payments

Appreciate if you could share release date

the profile2 part, the d.o profile project now has a -dev release and can be downloaded normally like the other modules

Firstly there are 2 pages called getting started. One is top level the other in Contributing > Getting Started

Also I think the order should be Installing > Getting Started > Contributing > .... Seems weird to be told how to contribute before how to install.

Just opened #2 and there is no build check and link to the PR build.

• Order Administration - see page: http://docs.drupalcommerce.org/v2/orders/index.html

  • Adding Orders
  • Editing Orders
  • Deleting Orders

• Product Administration - see page: http://docs.drupalcommerce.org/v2/product/index.html

  • Creating a product
    • See page: http://docs.drupalcommerce.org/v2/product/products.html
  • Creating a product catalog
    • See page: http://docs.drupalcommerce.org/v2/product/catalog-and-product-pages.html
  • Create a product variation
    • See page: http://docs.drupalcommerce.org/v2/product/products.html
  • Edit a product variation
  • Delete a product variation

• Product Attribute Administration - see page: http://docs.drupalcommerce.org/v2/product/product-attributes.html

  • Creating product attributes

• Store Administration - see page: http://docs.drupalcommerce.org/v2/store.html

  • Create store type
  • Update a store type
  • Delete a store type
  • Referencing a product to a store

• Currency Administration - see page: http://docs.drupalcommerce.org/v2/currency.html

  • Importing/Creating Currency

• Cart Administration

  • Adding/Editing/Deleting a product to and from the shopping cart

• Traits

  • Adding traits to a commerce entity

• Checkout - see page: http://docs.drupalcommerce.org/v2/checkout/index.html

  • Adding a new checkout workflow
  • Adding a checkout workflow plugin
    • See page: http://docs.drupalcommerce.org/v2/checkout/creating-a-checkout-flow-plugin.html
  • Editing a new checkout workflow
  • Deleting a new checkout workflow
  • Changing checkout pane settings
    • See page: http://docs.drupalcommerce.org/v2/checkout/customize.html
  • Adding a checkout pane plugin
    • See page: http://docs.drupalcommerce.org/v2/checkout/checkout-pane-plugin.html
  • Checkout as guest user
    • See page: http://docs.drupalcommerce.org/v2/checkout/guest.html
  • Registering from checkout pane

• Payment - see page: http://docs.drupalcommerce.org/v2/payments/index.html

  • Creating a payment gateway
    • TODO: http://docs.drupalcommerce.org/v2/payments/install-a-payment-gateway.html
  • Editing a payment gateway
  • Deleting a payment gateway
  • Creating a payment for an order
  • Refunding a payment for an order
  • Voiding a payment after creation
  • Deleting a payment after creation

• Promotion

  • Creating a promotion
    *TODO: http://docs.drupalcommerce.org/v2/creating-a-promotion.html
  • Applying a coupon

http://docs.drupalcommerce.org/v2/creating-a-promotion.html

• Screenshots
• Step-by-step on how to create a promotion

See https://www.drupal.org/node/2834968#comment-12006323 as an example why

http://docs.drupalcommerce.org/v2/payments/managing-order-payments.html

• How to locate an order and then find payments that are applied
• How to void a payment.
• How to capture a payment.
• How to refund a payment.
• How a saved credit card can be managed for your customers (where to find them and how to help a customer update or remove one)

This one shows old bundle label of "Product variation" should be updated to the "Default" http://docs.drupalcommerce.org/_images/attribute_create_04.png

I'm proposing a new structure that is more book like, like a cookbook format. This makes it easier to find topics and even redistribute. It also gives us room to notice where we're missing documentation coverage.

Original

• Installing
• Updating
• Getting Started
• Dependencies
  • Address
    • Zones
  • Profile
  • State machine
  • Inline Entity Form
• Currency
• Store
• Products
  • Attributes
  • Variations
  • Purchasable Entities
• Orders
  • Order types
  • Order items
  • Order processing
• Contributing
  • Getting started
  • Developing
• Code Recipes

Proposed

• Getting Started
  • Introduction to Composer
  • Installing
  • Updating
  • Contributing
    • Developing
• Essential Components
  • Address
  • Profile
  • State machine
  • Inline entity form
  • Currency
• Managing Products
  • Creating attributes
  • Making a product
  • Creating a product type
  • Advanced topics
    • Purchasable attributes
    • Code recipes
• Working with orders
  • Using order types
  • Orders and order items
  • Advanced topics
    • Order processing
    • Code recipes
• Setting up checkout
  • Configuring checkout
  • Advanced topics
    • Creating a checkout pane plugin
    • Creating a checkout flow plugin
• Setting up payments
  • Install a payment gateway
• Using promotions
  • Create promotion, coupon.
• Code recipes
  • Links to each advanced topic for tl;dr users

From bojan:

See https://commerceguys.fr/blog/zoom-sur-modules-paiement-pour-drupal-commerce

The simple page is up at http://docs.drupalcommerce.org/v2/payments/available-payment-gateways.html, resembling the table in the blog post would be a good way to go.

on
Enter the store country: United States
I get
[CommerceGuys\Intl\Exception\UnknownCountryException]

I'm trying to find best way to manage company's data (users, stores, products etc) in a marketplace scenario. What's your recommendation? I've been playing with https://www.drupal.org/project/group and it seems like a way to go.

After you have added "Color" and the various colors your t-shirts are available in, the next step is to add that "color" attribute to our product. Store administrators can do this on the product variation type form, the checkbox in the last step automatically created entity referenced fields as needed:

This jumps into a picture of the product edit. But let's clarify this just shows the end result, and not next step. Or if we want it to be the next step, link to Make a Product documentation page

When adding a new plugin, still need to make config entity for it.