Add notice for outdated docs in Woo Blocks repo (#12136)

woocommerce · Dec 20, 2023 · f29c5f4 · f29c5f4
1 parent 1751386
commit f29c5f4
Show file tree

Hide file tree

Showing 346 changed files with 2,768 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # WooCommerce Blocks <!-- omit in toc -->
 
 [![Latest Tag](https://img.shields.io/github/tag/woocommerce/woocommerce-gutenberg-products-block.svg?style=flat&label=Latest%20Tag)](https://github.com/woocommerce/woocommerce-gutenberg-products-block/releases)

diff --git a/assets/js/base/components/README.md b/assets/js/base/components/README.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # WooCommerce Blocks - General Purpose Components
 
 These are shared components used in WooCommerce blocks, and may be used in the store front end (shopper experience) as well as the editor or admin dashboard.

diff --git a/assets/js/blocks/README.md b/assets/js/blocks/README.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # Blocks
 
 Our blocks are generally made up of up to 4 files:

diff --git a/assets/js/blocks/classic-template/README.md b/assets/js/blocks/classic-template/README.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # Classic Template Block <!-- omit in toc -->
 
 ## Table of Contents <!-- omit in toc -->

diff --git a/assets/js/data/README.md b/assets/js/data/README.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # Data Stores
 
 The docs for the Data Stores can be found in [docs/third-party-developers/extensibility/data-store/README.md](../../../docs/third-party-developers/extensibility/data-store/README.md)
diff --git a/assets/js/data/cart/README.md b/assets/js/data/cart/README.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # Cart Store
 
 The docs for the Cart Store can be found in [docs/third-party-developers/extensibility/data-store/cart.md](../../../../docs/third-party-developers/extensibility/data-store/cart.md).
diff --git a/assets/js/data/checkout/README.md b/assets/js/data/checkout/README.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # Checkout Store
 
 The docs for the Checkout Store can be found in [docs/third-party-developers/extensibility/data-store/checkout.md](../../../../docs/third-party-developers/extensibility/data-store/checkout.md).
diff --git a/assets/js/data/collections/README.md b/assets/js/data/collections/README.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # Collections Store
 
 The docs for the Collections Store can be found in [docs/third-party-developers/extensibility/data-store/collections.md](../../../../docs/third-party-developers/extensibility/data-store/collections.md).
diff --git a/assets/js/data/payment/README.md b/assets/js/data/payment/README.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # Payment Store
 
 The docs for the Payment Store can be found in [docs/third-party-developers/extensibility/data-store/payment.md](../../../../docs/third-party-developers/extensibility/data-store/payment.md).
diff --git a/assets/js/data/query-state/README.md b/assets/js/data/query-state/README.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # Query State Store
 
 The docs for the Query State Store can be found in [docs/third-party-developers/extensibility/data-store/query-state.md](../../../../docs/third-party-developers/extensibility/data-store/query-state.md).
diff --git a/assets/js/data/schema/README.md b/assets/js/data/schema/README.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # Schema Store
 
 The docs for the Schema Store can be found in [docs/third-party-developers/extensibility/data-store/schema.md](../../../../docs/third-party-developers/extensibility/data-store/schema.md).
diff --git a/assets/js/data/store-notices/README.md b/assets/js/data/store-notices/README.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # Store-Notice Store
 
 The docs for the Schema Store can be found in [docs/third-party-developers/extensibility/data-store/store-notices.md](../../../../docs/third-party-developers/extensibility/data-store/store-notices.md).
diff --git a/assets/js/data/validation/README.md b/assets/js/data/validation/README.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # Validation Store
 
 The docs for the Validation Store can be found in [docs/third-party-developers/extensibility/data-store/validation.md](../../../../docs/third-party-developers/extensibility/data-store/validation.md).
diff --git a/assets/js/editor-components/README.md b/assets/js/editor-components/README.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # Editor Components
 
 These are shared components used in WooCommerce blocks for the editor (Gutenberg) UI.

diff --git a/assets/js/editor-components/search-list-control/README.md b/assets/js/editor-components/search-list-control/README.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # SearchListControl <!-- omit in toc -->
 
 ## Table of contents <!-- omit in toc -->

diff --git a/assets/js/editor-components/tag/README.md b/assets/js/editor-components/tag/README.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # Tag <!-- omit in toc -->
 
 ## Table of contents <!-- omit in toc -->

diff --git a/assets/js/editor-components/text-toolbar-button/README.md b/assets/js/editor-components/text-toolbar-button/README.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # TextToolbarButton <!-- omit in toc -->
 
 TextToolbarButton is used in Toolbar for text buttons which show `isToggled` state.

diff --git a/assets/js/icons/README.md b/assets/js/icons/README.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # Icons <!-- omit in toc -->
 
 ## Table of contents <!-- omit in toc -->

diff --git a/bin/changelog/README.md b/bin/changelog/README.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # Changelog Script
 
 This folder contains the logic for a changelog script that can be used for generating changelog entries from either pull requests added to a GitHub milestone, or pull requests that are part of a Zenhub release.

diff --git a/docs/README.md b/docs/README.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # WooCommerce Blocks Handbook <!-- omit in toc -->
 
 ## Table of Contents <!-- omit in toc -->

diff --git a/docs/contributors/README.md b/docs/contributors/README.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # Contributing
 
 If you're a developer or contributor eager to get started with WooCommerce Block Development, this documentation folder is your perfect starting point.

diff --git a/docs/contributors/block-assets.md b/docs/contributors/block-assets.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # Block Script Assets <!-- omit in toc -->
 
 ## Table of contents <!-- omit in toc -->

diff --git a/docs/contributors/coding-guidelines.md b/docs/contributors/coding-guidelines.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # Coding Guidelines <!-- omit in toc -->
 
 ## Table of contents <!-- omit in toc -->

diff --git a/docs/contributors/components.md b/docs/contributors/components.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # Storybook & Components
 
 This repo includes [Storybook](https://storybook.js.org) tooling so we can test and develop components in isolation.

diff --git a/docs/contributors/css-build-system.md b/docs/contributors/css-build-system.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # CSS Build System <!-- omit in toc -->
 
 ## Table of contents <!-- omit in toc -->

diff --git a/docs/contributors/documentation-guidelines.md b/docs/contributors/documentation-guidelines.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # Documentation Guidelines <!-- omit in toc -->
 
 ## Table of contents <!-- omit in toc -->

diff --git a/docs/contributors/e2e-guidelines.md b/docs/contributors/e2e-guidelines.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # E2E Guidelines <!-- omit in toc -->
 
 ## Table of contents <!-- omit in toc -->

diff --git a/docs/contributors/folder-structure.md b/docs/contributors/folder-structure.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # Folder Structure
 
 The following snippet explains how the WooCommerce Blocks repository is structured omitting irrelevant or obvious items with further explanations:

diff --git a/docs/contributors/getting-started.md b/docs/contributors/getting-started.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # Getting Started <!-- omit in toc -->
 
 ## Table of contents <!-- omit in toc -->

diff --git a/docs/contributors/javascript-build-system.md b/docs/contributors/javascript-build-system.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # JavaScript Build System <!-- omit in toc -->
 
 ## Table of contents <!-- omit in toc -->

diff --git a/docs/contributors/javascript-testing.md b/docs/contributors/javascript-testing.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # JavaScript Testing <!-- omit in toc -->
 
 ## Table of contents <!-- omit in toc -->

diff --git a/docs/contributors/storybook-and-components.md b/docs/contributors/storybook-and-components.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # Storybook & Components <!-- omit in toc -->
 
 ## Table of contents <!-- omit in toc -->

diff --git a/docs/designers/theming/README.md b/docs/designers/theming/README.md
@@ -1,3 +1,11 @@
+# 📣 Announcement: New documentation location
+
+The documentation for WooCommerce Blocks has moved to the [WooCommerce monorepo](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce-blocks/docs/).
+
+Please refer to the documentation in the new location as the files in this repository will no longer be updated and the repository will be archived.
+
+---
+
 # Theming
 
 This page includes all documentation regarding WooCommerce Blocks and themes.