Skip to content

Commit

Permalink
THEMES-1908: republishing all blocks via readme changes. (#2114)
Browse files Browse the repository at this point in the history
  • Loading branch information
vgalatro authored May 6, 2024
1 parent 441565a commit 86881db
Show file tree
Hide file tree
Showing 68 changed files with 1 addition and 67 deletions.
1 change: 0 additions & 1 deletion blocks/ad-taboola-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/ad-taboola-block`

_Block that implement a [Taboola Block](https://www.taboola.com/)._

## Props
Expand Down
1 change: 0 additions & 1 deletion blocks/ads-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/ads-block`

_This is the `AdsBlock` feature that utilizes the ArcAds library to render Google DFP advertisements. It will allow PageBuilder editors to select an 'Ad Type' as well as 'display' configuration option. It also includes the option of displaying or hiding an 'ADVERTISEMENT' label above the ad unit._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/alert-bar-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/alert-bar-block`

_This is the alert bar block that feeds from the `alert-bar-content-source-block`. It will refresh every 30 seconds by default, but the content source will return cached results every two minutes. This is to not overwhelm the content API with simultaneous refreshes for any less intervals._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/alert-bar-content-source-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/collections-content-source-block`

This is the content source that feeds the `alert-bar-block`. While the alert bar itself will refresh 30 seconds by default, this content source will refresh the cached results every two minutes. This is to not overwhelm the content API with simultaneous refreshes for any less intervals.

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/article-body-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/article-body-block`

_Fusion News Theme article-body block_

// TODO: add badge for passing/failing tests
Expand Down
1 change: 0 additions & 1 deletion blocks/article-tag-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/article-tag-block`

_Fusion News Article Tags block_

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/author-bio-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/author-bio-block`

_Author Short Biography block for Fusion News Theme_

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/author-content-source-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/author-content-source-block`

Fusion News Theme author API content source block
_Please provide a 1-2 sentence description of what the block is and what it does._

Expand Down
1 change: 0 additions & 1 deletion blocks/byline-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/byline-block`

Byline block for Fusion News Theme

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/card-list-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/card-list-block`

Fusion News Theme card list block
_Please provide a 1-2 sentence description of what the block is and what it does._

Expand Down
1 change: 0 additions & 1 deletion blocks/collections-content-source-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/collections-content-source-block`

Fusion News Theme content API collections content source block. _Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/content-api-source-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/content-api-source-block`

Content source block for Content API queries, used for retrieving stories from the content API. _Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/date-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/date-block`

Fusion News Theme date block. _Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/default-output-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/default-output-block`

Fusion News Theme default output type. _Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/double-chain-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/double-chain-block`

Fusion News Theme double-chain block. Takes in a number of how many items to be put in column one. The rest go in column two. Negative numbers here will yield nothing.

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/event-tester-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/event-tester-block`

_Fusion News Theme event tester block. Used for testing the event emitter. When new events are created, they should be subscribed to in this component in the constructor. When this component is added to a page, it will not render anything visually. It will console.log a message altering you what event has been consumed and also dump our the event object that can be inspected to ensure the correct data was captured._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/extra-large-manual-promo-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/extra-large-manual-promo-block`

_Block containing an extra large manual promo component. Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/extra-large-promo-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/extra-large-promo-block`

_Block containing an extra large promo component. Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/footer-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/header-nav-block`

_Footer block for the Fusion News Theme. This will pull the data from the footer hierarchy from the organization's site service._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/full-author-bio-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/full-author-bio-block`

_Fusion News Theme full author bio block. Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/gallery-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/gallery-block`

_Block containing a gallery that reads in a gallery from a content source or globalContent._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/global-phrases-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/global-phrases-block`

_A package containing a set of translated phrases expected to be available globally. For example, if there is a commonly used SDK component that depends on a set of translated phrases such as the Gallery component, its phrases will likely make sense here._

_The translations can be found the `intl.json` file._
Expand Down
1 change: 0 additions & 1 deletion blocks/header-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@arc-test-org/header-block`

_Fusion News Theme header block. Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/header-nav-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/header-nav-block`

_Block containing our News Theme nav for the header. Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/header-nav-chain-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/header-nav-chain-block`

This block is intended to be used as the header navigation chain block.

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/headline-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/headline-block`

_Fusion News Theme headline block. Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/htmlbox-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/htmlbox-block`

_HTML Box for block for Fusion News Theme. Please provide a 1-2 sentence description of what the block is and what it does._

// TODO: add badge for passing/failing tests
Expand Down
1 change: 0 additions & 1 deletion blocks/identity-block/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
# `@wpmedia/identity-block`

ARC XP Themes Identity block for handling integrating ARC's identity into a theme's website.
1 change: 0 additions & 1 deletion blocks/large-manual-promo-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/large-manual-promo-block`

_Block containing a large manual promo component. Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/large-promo-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/large-promo-block`

_Block containing a large promo component. Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/lead-art-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/lead-art-block`

_Fusion News Theme lead art block. Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/links-bar-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/header-nav-block`

_This is the links bar block for the news theme, written as a functional component. It pulls the menu data from the site service content source.# Name of Block_

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/masthead-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/masthead-block`

_Fusion News Theme masthead block is a relatively simple feature that is typically only used on newspaper homepages. It displays the logo, the date, a tag line, and an optional link (usually to a Weather page but could be to other pages)._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/medium-manual-promo-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/medium-manual-promo-block`

_Block containing a medium manual promo component. Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/medium-promo-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/medium-promo-block`

_Block containing a medium promo component. Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/numbered-list-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/numbered-list-block`

_Numbered List block for Fusion News Theme. Displays a numbered list where each list item will have a number, headline and an Image._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/overline-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/overline-block`

_Fusion News Theme Overline block. Text usually displayed over the headline. By default will use the ANS fields Label or Web Site Section if they exist or optionally a custom text and url can be used._

## Props
Expand Down
1 change: 0 additions & 1 deletion blocks/placeholder-image-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/placeholder-image-block`

_Fusion News Theme placeholder image. The intended use is to take the feature pack fallback image, as an external url or relative path._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/quad-chain-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/triple-chain-block`

_Fusion News Theme quad-chain block. Utilizes bootstrap's three column approach on anything but small size._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/related-content-content-source-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/related-content-content-source-block`

_Content source block to get stories related content, using the story Id as key._

## Configurable Params
Expand Down
1 change: 0 additions & 1 deletion blocks/resizer-image-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/resizer-image-block`

_This is a helper to transform the return value of the content sources. This is specifically to make sure that resized image urls are available at themes' `blocks.json` widths._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/resizer-image-content-source-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/resizer-image-content-source-block`

_This is specifically to make sure that resized image urls are available at themes' `blocks.json` widths._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/results-list-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/results-list-block`

_Results List block for Fusion News Theme. Displays a results list where each result card will have a description, headline, byline block and publish date. ._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/right-rail-advanced-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/right-rail-advanced-block`

_Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/right-rail-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/right-rail-block`

_Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/search-content-source-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/search-content-source-block`

_Fusion News Theme unpublished API content source block. Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/search-results-list-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/search-results-list-block`

_Search Results List block for Fusion News Theme. This block displays a search bar with a results list where each result card will have a description, headline, byline block and publish date._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/section-title-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/section-title-block`

_Fusion News Theme section title block# Name of Block. Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/share-bar-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/share-bar-block`

_This is the share bar block for the news theme, written as a functional component. Users can choose out of five options (email, facebook, pinterest, linkedin, twitter) which selection of share buttons will be displayed on articles. Clicking on each button will open up a new window._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/shared-styles/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/shared-styles`

This block is reused by others for the time being.

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/simple-list-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/simple-list-block`

_Fusion News Theme Simple List block is a dynamically-sized list with items of a title and image. The list itself also has a title._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/single-chain-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/single-chain-block`

_Fusion News Theme single-chain block. Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/site-hierarchy-content-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/site-hierarchy-content-block`

_Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/small-manual-promo-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/small-manual-promo-block`

_Block containing a small manual promo component. Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/small-promo-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/small-promo-block`

_Block containing a small promo component. Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/story-feed-author-content-source-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/story-feed-author-content-source-block`

_Content source block for story feed queries by author. Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/story-feed-query-content-source-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/story-feed-query-content-source-block`

_Content source block for story feed queries by Elasticsearch queries. Please provide a 1-2 sentence description of what the block is and what it does._

// TODO: add badge for passing/failing tests
Expand Down
1 change: 0 additions & 1 deletion blocks/story-feed-sections-content-source-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/story-feed-sections-content-source-block`

_Content source block for story feed queries by section. Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/story-feed-tag-content-source-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/story-feed-tag-content-source-block`

_Content source block for story feed queries by tag. Please provide a 1-2 sentence description of what the block is and what it does._

// TODO: add badge for passing/failing tests
Expand Down
1 change: 0 additions & 1 deletion blocks/subheadline-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/subheadline-block`

_Fusion News Theme sub-headline block. Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 1 addition & 0 deletions blocks/subscriptions-block/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
# `@wpmedia/subscriptions-block`
ARC XP Themes Subscriptions block for handling integrating ARC's Subscription service into a theme's website.
1 change: 0 additions & 1 deletion blocks/tag-title-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/tag-title-block`

_Fusion News Theme tag title block. Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/tags-content-source-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/tags-content-source-block`

_Fusion News Theme tags API content source block. Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/top-table-list-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/top-table-list-block`

_Fusion News Theme top table list block. Please provide a 1-2 sentence description of what the block is and what it does._

// TODO: add badge for passing/failing tests
Expand Down
1 change: 0 additions & 1 deletion blocks/triple-chain-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/triple-chain-block`

_Fusion News Theme triple-chain block. Utilizes bootstrap's three column approach on anything but small size. Takes in a number of how many items to be put in column one and two. The rest go in column three. Negative numbers here will yield nothing._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/unpublished-content-source-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/unpublished-content-source-block`

_Fusion News Theme unpublished API content source block. Please provide a 1-2 sentence description of what the block is and what it does._

## Acceptance Criteria
Expand Down
1 change: 0 additions & 1 deletion blocks/video-player-block/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# `@wpmedia/video-player-block`

_Fusion News Theme video player block. Provides a feature to play videos._

## Acceptance Criteria
Expand Down
Loading

0 comments on commit 86881db

Please sign in to comment.