b808843564
* Updating documentation for the relevancy feed This looks to remove the chatter of the document and instead point folks to locations within the code. Closes forem/forem#17245 * Update app/models/articles/feeds/README.md Co-authored-by: Julianna Tetreault <32834804+juliannatetreault@users.noreply.github.com> * Update app/models/articles/feeds/README.md Co-authored-by: Arit Amana <32520970+msarit@users.noreply.github.com> * Update app/models/articles/feeds/README.md Co-authored-by: Arit Amana <32520970+msarit@users.noreply.github.com> * Update app/models/articles/feeds/README.md Co-authored-by: Arit Amana <32520970+msarit@users.noreply.github.com> * Update app/models/articles/feeds/README.md Co-authored-by: Arit Amana <32520970+msarit@users.noreply.github.com> * Update app/models/articles/feeds/README.md Co-authored-by: Arit Amana <32520970+msarit@users.noreply.github.com> * Update app/models/articles/feeds/README.md Co-authored-by: Arit Amana <32520970+msarit@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Arit Amana <32520970+msarit@users.noreply.github.com> * Update app/models/articles/feeds/README.md Co-authored-by: Arit Amana <32520970+msarit@users.noreply.github.com> Co-authored-by: Julianna Tetreault <32834804+juliannatetreault@users.noreply.github.com> Co-authored-by: Arit Amana <32520970+msarit@users.noreply.github.com>
1.8 KiB
Feed Configuration
Welcome to the technical documentation of the Feed Configuration. It's structured as an index pointing you to related files.
Historical Documents
- The Articles::Feeds::WeightedQueryStrategy is the precursor to the more robust feed configuration.
- This post walked through the meaning of each of the initial relevancy levers.
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.