Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(content-blog): blog Atom feed id + RSS feed guid should be fully qualified urls #8381

Merged
merged 3 commits into from Nov 30, 2022

Conversation

johnnyreilly
Copy link
Contributor

@johnnyreilly johnnyreilly commented Nov 27, 2022

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

Closes #8380

The Atom feed fails validation:

The error:

id must be a full and valid URL

image

The same issue exists for RSS.

I've been able to patch it on my own blog using this: https://github.com/johnnyreilly/blog.johnnyreilly.com/pull/357/files#diff-a6704bb15d419cd24c7a855d8188b83b36aa4a6011c40b63c8dc9f5bb60fc2ed

It would be better to fix at source - this PR does that by setting id to be the URL as required.

Test Plan

See updated snapshots.

See successful validation on deploy preview:

image

Test links

Deploy preview: https://deploy-preview-8381--docusaurus-2.netlify.app/blog/atom.xml

It's worth noting that there's an outstanding issue with RSS feeds as RSS doesn't support multiple authors. However this is a limitation of the RSS standard. Atom is incidentally fine.

Related issues/PRs

#8380

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Nov 27, 2022
@johnnyreilly johnnyreilly changed the title Fix Atom guid / RSS id so they are validate Fix Atom feed guid / RSS feed id so both validate successfully Nov 27, 2022
@netlify
Copy link

netlify bot commented Nov 27, 2022

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit 8bf7488
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/63832b9606bfdd00088f1041
😎 Deploy Preview https://deploy-preview-8381--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions
Copy link

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟢 94 🟢 97 🟢 100 🟢 100 🟢 90 Report
/docs/installation 🟠 75 🟢 100 🟢 100 🟢 100 🟢 90 Report

@johnnyreilly johnnyreilly changed the title Fix Atom feed guid / RSS feed id so both validate successfully Fix Atom feed guid / RSS feed id so they do not fail RSS validation Nov 27, 2022
@slorber slorber changed the title Fix Atom feed guid / RSS feed id so they do not fail RSS validation fix(content-blog): Atom id + RSS feed guid should be fully qualified urls Nov 30, 2022
@slorber slorber changed the title fix(content-blog): Atom id + RSS feed guid should be fully qualified urls fix(content-blog): blog Atom feed id + RSS feed guid should be fully qualified urls Nov 30, 2022
@slorber
Copy link
Collaborator

slorber commented Nov 30, 2022

@slorber slorber added the pr: bug fix This PR fixes a bug in a past release. label Nov 30, 2022
@slorber slorber merged commit 7921467 into facebook:main Nov 30, 2022
@slorber slorber added the to backport This PR is planned to be backported to a stable version of Docusaurus label Jan 26, 2023
slorber pushed a commit that referenced this pull request Jan 26, 2023
@slorber slorber added backported This PR has been backported to a stable version of Docusaurus and removed to backport This PR is planned to be backported to a stable version of Docusaurus labels Jan 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backported This PR has been backported to a stable version of Docusaurus CLA Signed Signed Facebook CLA pr: bug fix This PR fixes a bug in a past release.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

RSS and Atom feeds fail validation
3 participants