docbrown/app/models/articles/feeds
Ben Halpern f70bc2b0b8
Add internal tool to preview feed configs (#18544)
* Add internal tool to preview feed configs

* Update app/services/articles/feeds/variant_query.rb
2022-10-06 07:48:44 -04:00
..
lever_catalog_builder.rb Allowing VariantQuery for Feed Generation (#17382) 2022-04-21 11:07:09 -04:00
order_by_lever.rb Allowing VariantQuery for Feed Generation (#17382) 2022-04-21 11:07:09 -04:00
README.md Updating documentation for the relevancy feed (#17503) 2022-04-29 09:50:05 -04:00
relevancy_lever.rb Refactoring so relevancy levers define expected variables (#17591) 2022-05-06 13:54:33 -04:00
variant_assembler.rb Add internal tool to preview feed configs (#18544) 2022-10-06 07:48:44 -04:00

Feed Configuration

Welcome to the technical documentation of the Feed Configuration. It's structured as an index pointing you to related files.

Historical Documents

In addition there are two code walk throughs explaining the pull requests that introduced the VariantQuery:

So You Want to Change the Relevancy Feed

The forem/forem#17406 pull request contains an example of configuring a VariantQuery You can also read the config/feed-variants/README.md for further context.

Understanding the Variant Query

In Diving into Dev's Relevancy Feed Builder we explained the conceptual implementation; providing a conceptual entity relationship and sequence diagrams.

The key thing to understand is as follows: We create a SQL statement that calculates a relevancy_score for a given user and each article in the Forem instance. The higher the article's relevancy_score, the closer that article will be to the top of the feed.