Skip to content
This repository has been archived by the owner on Feb 23, 2024. It is now read-only.

Add new doc referencing feature flags and experimental interfaces. #3348

Merged
merged 9 commits into from
Oct 30, 2020

Conversation

nerrad
Copy link
Contributor

@nerrad nerrad commented Oct 30, 2020

As a part of the work we do in this repository, we utilize feature flags and _experimental prefix for in progress items that have various levels of surfacing to users of the plugin. This allows us to continuously commit to trunk and optionally progressively rollout items for in development use, exposure in the feature plugin, or availability when Blocks are included in WooCommerce core as a package.

This pull request adds some documentation that:

  • briefly describes what feature flags and experimental interfaces we use.
  • documents what is currently behind a feature flag or utilizing an experimental interface.

The goal is to have this document as an up to date resource for our repository to keep track of all these implementations as well as for regular review of what should be graduated to a stable feature/api.

@nerrad nerrad requested a review from a team as a code owner October 30, 2020 13:57
@nerrad nerrad requested review from haszari and Aljullu and removed request for a team October 30, 2020 13:57
@nerrad nerrad added focus: documentation This issue is a request for better documentation. status: needs review labels Oct 30, 2020
@github-actions
Copy link
Contributor

github-actions bot commented Oct 30, 2020

Size Change: 0 B

Total Size: 1.12 MB

ℹ️ View Unchanged
Filename Size Change
build/active-filters-frontend.js 8.88 kB 0 B
build/active-filters.js 8.94 kB 0 B
build/all-products-frontend.js 31.2 kB 0 B
build/all-products.js 36.1 kB 0 B
build/all-reviews.js 9.78 kB 0 B
build/atomic-block-components/add-to-cart-frontend.js 8.94 kB 0 B
build/atomic-block-components/add-to-cart.js 7.52 kB 0 B
build/atomic-block-components/add-to-cart~atomic-block-components/button.js 3.19 kB 0 B
build/atomic-block-components/add-to-cart~atomic-block-components/image~atomic-block-components/title.js 335 B 0 B
build/atomic-block-components/button-frontend.js 2.02 kB 0 B
build/atomic-block-components/button.js 840 B 0 B
build/atomic-block-components/category-list-frontend.js 469 B 0 B
build/atomic-block-components/category-list.js 478 B 0 B
build/atomic-block-components/image-frontend.js 1.7 kB 0 B
build/atomic-block-components/image.js 1.15 kB 0 B
build/atomic-block-components/price-frontend.js 2.29 kB 0 B
build/atomic-block-components/price.js 2.32 kB 0 B
build/atomic-block-components/rating-frontend.js 524 B 0 B
build/atomic-block-components/rating.js 526 B 0 B
build/atomic-block-components/sale-badge-frontend.js 857 B 0 B
build/atomic-block-components/sale-badge.js 863 B 0 B
build/atomic-block-components/sku-frontend.js 386 B 0 B
build/atomic-block-components/sku.js 395 B 0 B
build/atomic-block-components/stock-indicator-frontend.js 568 B 0 B
build/atomic-block-components/stock-indicator.js 573 B 0 B
build/atomic-block-components/summary-frontend.js 917 B 0 B
build/atomic-block-components/summary.js 927 B 0 B
build/atomic-block-components/tag-list-frontend.js 467 B 0 B
build/atomic-block-components/tag-list.js 474 B 0 B
build/atomic-block-components/title-frontend.js 1.23 kB 0 B
build/atomic-block-components/title.js 1.06 kB 0 B
build/attribute-filter-frontend.js 18.3 kB 0 B
build/attribute-filter.js 12.5 kB 0 B
build/blocks.js 3.54 kB 0 B
build/cart-frontend.js 70.1 kB 0 B
build/cart.js 38.8 kB 0 B
build/checkout-frontend.js 86 kB 0 B
build/checkout.js 42.1 kB 0 B
build/editor-rtl.css 13.8 kB 0 B
build/editor.css 13.9 kB 0 B
build/featured-category.js 7.73 kB 0 B
build/featured-product.js 9.97 kB 0 B
build/handpicked-products.js 7.37 kB 0 B
build/price-filter-frontend.js 14.9 kB 0 B
build/price-filter.js 10.4 kB 0 B
build/product-best-sellers.js 7.45 kB 0 B
build/product-categories.js 3.23 kB 0 B
build/product-category.js 8.38 kB 0 B
build/product-new.js 7.61 kB 0 B
build/product-on-sale.js 8 kB 0 B
build/product-search.js 3.56 kB 0 B
build/product-tag.js 6.53 kB 0 B
build/product-top-rated.js 7.58 kB 0 B
build/products-by-attribute.js 8.35 kB 0 B
build/reviews-by-category.js 11.8 kB 0 B
build/reviews-by-product.js 13.4 kB 0 B
build/reviews-frontend.js 9.37 kB 0 B
build/single-product-frontend.js 33.8 kB 0 B
build/single-product.js 10.1 kB 0 B
build/style-rtl.css 17.9 kB 0 B
build/style.css 17.9 kB 0 B
build/vendors-style-rtl.css 1.03 kB 0 B
build/vendors-style.css 1.03 kB 0 B
build/vendors.js 417 kB 0 B
build/vendors~atomic-block-components/price-frontend.js 5.65 kB 0 B
build/wc-blocks-data.js 7.1 kB 0 B
build/wc-blocks-middleware.js 931 B 0 B
build/wc-blocks-registry.js 2.32 kB 0 B
build/wc-payment-method-bacs.js 790 B 0 B
build/wc-payment-method-cheque.js 787 B 0 B
build/wc-payment-method-cod.js 879 B 0 B
build/wc-payment-method-paypal.js 831 B 0 B
build/wc-payment-method-stripe.js 12 kB 0 B
build/wc-settings.js 2.35 kB 0 B
build/wc-shared-context.js 1.53 kB 0 B
build/wc-shared-hocs.js 1.66 kB 0 B

compressed-size-action

Copy link
Contributor

@Aljullu Aljullu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some format comments + a question regarding sign-up on checkout, but everything else looking good. 👍

docs/blocks/feature-flags-and-experimental-interfaces.md Outdated Show resolved Hide resolved
docs/blocks/feature-flags-and-experimental-interfaces.md Outdated Show resolved Hide resolved
docs/blocks/feature-flags-and-experimental-interfaces.md Outdated Show resolved Hide resolved
docs/blocks/feature-flags-and-experimental-interfaces.md Outdated Show resolved Hide resolved
docs/blocks/feature-flags-and-experimental-interfaces.md Outdated Show resolved Hide resolved
@nerrad
Copy link
Contributor Author

nerrad commented Oct 30, 2020

Thanks for the great review Albert! I've addressed all the feedback and I'm going to skip checks to merge since these are only markdown changes.

@nerrad nerrad merged commit 196d278 into trunk Oct 30, 2020
@nerrad nerrad deleted the docs/feature-and-blocks-behind-a-flag branch October 30, 2020 14:35
@budzanowski budzanowski added this to the 3.8.0 milestone Nov 9, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
focus: documentation This issue is a request for better documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants