Skip to content

DOC-2608: Add an RSS feed for the TinyMCE Changelog#3566

Closed
FarzadHayat wants to merge 20 commits intotinymce/7from
hotfix/7/DOC-2608
Closed

DOC-2608: Add an RSS feed for the TinyMCE Changelog#3566
FarzadHayat wants to merge 20 commits intotinymce/7from
hotfix/7/DOC-2608

Conversation

@FarzadHayat
Copy link

@FarzadHayat FarzadHayat commented Dec 23, 2024

Ticket: DOC-2608

Changelog page

RSS Feed: http://docs-hotfix-7-doc-2608.staging.tiny.cloud/docs/tinymce/7/rss.xml

RSS Validator: https://validator.w3.org/feed/
RSS Viewer: https://rssviewer.app/
RSS Spec: https://www.rssboard.org/rss-specification

Changes:

  • Worked on this in my own time. Thought it would be a cool feature to have.
  • Add Antora extension to tinymce/7 to generate rss.xml during build process
  • Automatically updates when changelog.adoc is modified
  • Error handling mechanism to ensure build process continues if the extension fails for any reason
  • You can test it out by installing an RSS Reader on your smart phone and entering the RSS URL

Pre-checks:

  • Branch prefixed with feature/<version>/, hotfix/<version>/, staging/<version>/, or release/<version>/.
  • [-] modules/ROOT/nav.adoc has been updated (if applicable).
  • [-] Included a release note entry for any New product features.
  • [-] If this is a minor release, updated productminorversion in antora.yml and added new supported versions entry in modules/ROOT/partials/misc/supported-versions.adoc.

Review:

  • Documentation Team Lead has reviewed

@FarzadHayat FarzadHayat self-assigned this Dec 23, 2024
Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
@FarzadHayat FarzadHayat marked this pull request as ready for review January 2, 2025 00:21
Copy link

@LewisAtTiny LewisAtTiny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've spent the morning trying to understand RSS feeds and this is actually really cool! Good job Farzad!

Copy link
Contributor

@MitchC1999 MitchC1999 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well done! Seems like a nice feature to provide 👍 Should we provide a link to the xml file somewhere in the docs?

@kemister85
Copy link
Contributor

@FarzadHayat Nice work on this, I think we should create a user guide on how to set this up and stick it in the docs under new section?

@@ -4,6 +4,8 @@

NOTE: This is the {productname} Community version changelog. For information about the latest {cloudname} or {enterpriseversion} Release, see: xref:release-notes.adoc[{productname} Release Notes].

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
NOTE: This is the {productname} Community version changelog. For information about the latest {cloudname} or {enterpriseversion} Release, see: xref:release-notes.adoc[{productname} Release Notes].
NOTE: This is the {productname} Community version changelog. For information about the latest {cloudname} or {enterpriseversion} Release, see: xref:release-notes.adoc[{productname} Release Notes].
For an RSS feed of the {productname} changelog, use the following URL in any RSS reader: {site-url}/{page-component-name}/{page-component-version}/rss.xml.

@kemister85 @MitchC1999 Rather than a Tip admonition, could we add it here to the Note admonition, and mention the URL can be used in a RSS reader?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that would just add it as an extra line rather than a note box. I think its fine to include in a tip box

@soritaheng soritaheng requested a review from MitchC1999 April 4, 2025 05:56
@MitchC1999
Copy link
Contributor

Just realised this won't run on the main playbook, it's only working on the local playbook build we're publishing on dev branches. This extension will need to be investigated to work with the remote branches and moved to the main branch antora playbook.

@MitchC1999 MitchC1999 closed this Apr 4, 2025
@kemister85 kemister85 deleted the hotfix/7/DOC-2608 branch August 5, 2025 12:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants