Adding Feed Configuration documentation #17248
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This documentation outlines the scope and intention of the Feed Configuration, it's primary purpose is to: - Reference the historical context - Establish a draft glossary - Introduce high-level constraints - Serve as a document to help with the task break-down Closes #17244 Relates to #17245 Informs forem/forem-internal-eng#435 As a note, I'm looking at this document almost through the lens of [literate programming][1]. In writing the document, I learned about and attempted to describe the shape of this internal facing project. Consider for a moment that we are not adding a new user facing feature to the Forem code base. Instead we're scoping this project as helping ease the experimentation process regarding the feed. In other words the scope of this project is to help name and refine different feed strategies to understand what each strategy means. Eventually this could mean that creators and members can have a future opportunity to select feed strategies that reflect the aspirational community values of the feed (e.g. we want a feed that favors comments, or neighborhoods, or the occassional serendipity). [1]:https://en.wikipedia.org/wiki/Literate_programming
msarit
approved these changes
Apr 12, 2022
pr-triage
bot
added
PR: partially-approved
jgaskins
approved these changes
Apr 12, 2022
aitchiss
approved these changes
Apr 13, 2022
config/feed/README.md
Outdated
| [Articles::Feeds::WeightedQueryStrategy](https://github.com/forem/forem/blob/de2edee07d824a34e5c5445d455b1f8086bd127d/app/services/articles/feeds/weighted_query_strategy.rb) | ||
| is the precursor to the more robust feed configuration. It provides hints as | ||
| to how we'll structure the feed configuration. | ||
| - [These Are the [Feed] Levers I Know I Know - Forem Team 🌱](https://forem.team/jeremy/these-are-the-feed-levers-i-know-i-know-293m) |
There was a problem hiding this comment.
Should we link to your DEV post instead? I'm just thinking these docs are open source, but the forem.team post is private 🤔
Co-authored-by: Suzanne Aitchison <suzanne@forem.com>
pr-triage
bot
added
PR: unreviewed
Co-authored-by: Suzanne Aitchison <suzanne@forem.com>
Co-authored-by: Suzanne Aitchison <suzanne@forem.com>
pr-triage
bot
added
PR: merged
jeremyf
added a commit
that referenced
this pull request
Apr 13, 2022
* main: (72 commits) Adding Feed Configuration documentation (#17248) Bump @honeybadger-io/js from 3.2.8 to 3.2.9 (#17257) Bump @testing-library/user-event from 13.5.0 to 14.1.0 (#17253) Bump @storybook/addon-controls from 6.4.20 to 6.4.21 (#17232) move showModal helper into its own pack file (#17266) Show a "Unable to login" message in browser when a user is unable to login. (#17261) Bump sass from 1.49.9 to 1.50.0 (#17264) Bump @storybook/addon-storysource from 6.4.20 to 6.4.21 (#17256) These two tests are time zone sensitive (#17263) Bump @storybook/addon-links from 6.4.20 to 6.4.21 (#17249) Add minimal test on rss feed response (#17221) chore: typo (#17258) Refactor Member Index View Users Query (#17251) Bump @babel/core from 7.17.8 to 7.17.9 (#17254) Bump prettier from 2.5.1 to 2.6.2 (#17255) Add Internationalization to Admin::UsersController Success Messages (#17252) Bump @storybook/builder-webpack5 from 6.4.20 to 6.4.21 (#17237) Bump preact from 10.6.6 to 10.7.1 (#17250) Bump eslint from 8.12.0 to 8.13.0 (#17247) First version of exporting the Users to a CSV (#17217) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this? (check all applicable)
Description
This documentation outlines the scope and intention of the Feed
Configuration, it's primary purpose is to:
As a note, I'm looking at this document almost through the lens of
literate programming. In writing the document, I learned about and
attempted to describe the shape of this internal facing project.
Consider for a moment that we are not adding a new user facing feature
to the Forem code base. Instead we're scoping this project as helping
ease the experimentation process regarding the feed.
In other words the scope of this project is to help name and refine
different feed strategies to understand what each strategy means.
Eventually this could mean that creators and members can have a
future opportunity to select feed strategies that reflect the
aspirational community values of the feed (e.g. we want a feed that
favors comments, or neighborhoods, or the occassional serendipity).
Related Tickets & Documents
Closes #17244
Relates to #17245
Informs forem/forem-internal-eng#435
QA Instructions, Screenshots, Recordings
Read through the document, ask questions, seek clarification.
UI accessibility concerns?
None.
Added/updated tests?
[Forem core team only] How will this change be communicated?