USWDS-Site - Updates: Add configurable RSS/Atom feed option #2924
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
feed output configurable through _config.yml feed [path, format]
mejiaj
added
the
Status: Triage
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.
Summary
Added a configurable RSS or Atom feed option to allow users to subscribe to site updates. This enables users to receive updates in their preferred feed format.
Related issue
Closes #754
Preview link
Preview link: Run locally at http://localhost:4000/rss.xml or http://localhost:4000/feed.xml to view the generated feed.
Problem statement
The USWDS site lacked a feed to allow users to subscribe to updates. Users had no way to receive automated updates, which could reduce engagement with new releases or information.
Solution
This PR introduces a configurable feed option using the
jekyll-feedplugin. Users can now choose between RSS and Atom formats by configuring_config.ymlwith thefeed.formatoption.Major changes
jekyll-feedto the Gemfile_config.ymlto allow RSS or Atom format selectionTesting and review
bundle exec jekyll serve.http://localhost:4000/rss.xmlorhttp://localhost:4000/feed.xmlto view the feed.Feedback requested: Ensure the feed configuration works as expected and validate compatibility with common feed readers.