feat: generate rss feed #364

davifantasia · 2020-04-14T13:36:13Z

Closes #361

…ng for html node

vercel · 2020-04-14T13:36:17Z

This pull request is being automatically deployed with ZEIT Now (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://zeit.co/commercetools/commercetools-docs-kit/7j98g6su9
✅ Preview: https://commercetools-docs-kit-git-rss-feed.commercetools.now.sh

…ls-docs-kit into rss-feed

emmenko · 2020-04-14T16:07:19Z

packages/gatsby-theme-docs/gatsby-config.js

      betaLink: null,
+      siteUrl: `https://${productionHostname}/${pluginOptions.websiteKey}`,


Note: the websiteKey is not a guarantee that it's the same as the URL path.

What you're looking for is the pathPrefix I think.

packages/gatsby-theme-docs/gatsby-config.js

@@ -210,6 +213,54 @@ module.exports = (themeOptions = {}) => {
      'gatsby-plugin-remove-trailing-slashes',
      'gatsby-plugin-meta-redirect',
      'gatsby-plugin-netlify-cache',
+      {
+        resolve: 'gatsby-plugin-feed',


nkuehn

A bunch of comments concerning improving the content of the resulting feed.

See https://www.npmjs.com/package/rss#feedoptions for more precise descriptions than the GatsbyJS documentation example

packages/gatsby-theme-docs/gatsby-config.js

@@ -210,6 +213,54 @@ module.exports = (themeOptions = {}) => {
      'gatsby-plugin-remove-trailing-slashes',
      'gatsby-plugin-meta-redirect',
      'gatsby-plugin-netlify-cache',
+      {
+        resolve: 'gatsby-plugin-feed',


nkuehn · 2020-04-14T21:55:15Z

packages/gatsby-theme-docs/gatsby-config.js

+              query: `
+              {
+                allReleaseNotePage(
+                  sort: { order: DESC, fields: date },


We need to filter by a cutoff date to be able to reduce the feed to new entries only during migration. Or just live with it that users will get five old release notes again if they use a feed reader

Feeds should not contain the full history, only as many as a user initially subscribing the feed should immediately get in their reader UI and the longest period we imagine some client being offline to not check for updates.

We need to limit the number of entries to a reasonable amount. Currently we have five, which did the job in the past.

nkuehn · 2020-04-14T22:00:18Z

packages/gatsby-theme-docs/gatsby-config.js

+                ) {
+                    nodes {
+                      description
+                      body


If we don't find a solution for the encoding (see custom_elements) this field does not need to be queried any more.

nkuehn · 2020-04-14T22:12:29Z

packages/gatsby-theme-docs/gatsby-config.js

+                    ...node,
+                    url: site.siteMetadata.siteUrl + node.slug,
+                    guid: site.siteMetadata.siteUrl + node.slug,
+                    custom_elements: [{ 'content:encoded': node.body }],


MDX is not HTML, you can't just trow MDX into an RSS as HTML encoded content.

I don't know if it's realistic to get a usable plaintext or "minimal HTML" representation directly from the GraphQL for our (sometimes custom) MDX, so I wold be fine omitting it as we currently do, too.

But we can try - one option that publishers take is to put the excerpt until "read more" here so people move on to your actual website instead of staying in some feed consumer UI. But even then it has to be either plaintext or plain semantic HTML

nkuehn · 2020-04-14T22:27:15Z

packages/gatsby-theme-docs/gatsby-config.js

+              }
+            `,
+              output: '/release-notes.xml',
+              title: `${pluginOptions.websiteKey}'s rss feed`,


Let's try a better name :-)

pseudocode proposal: commercetools ${siteMetadata.title} Release Notes

…rom website

nkuehn

@davifantasia I did two small changes (see comments). omitting the full text is good, all the hacks we considered are just bad content.

Two things remain to be done:

only load and run the plugin when the theme option "hasReleaseNotes" is true.
move the plugin before the ones that are explicitly tagged as having to be the last ones in the list.

nkuehn · 2020-04-15T19:32:14Z

packages/gatsby-theme-docs/gatsby-config.js

+                      slug
+                      title
+                      date
+                      categories: topics


I added this as a quick win feature

nkuehn · 2020-04-15T19:33:40Z

packages/gatsby-theme-docs/gatsby-node.js

@@ -267,7 +267,7 @@ function generateReleaseNoteSlug(node) {
  const date = node.frontmatter.date ? node.frontmatter.date.split('T')[0] : '';
  const title = node.frontmatter.title ? node.frontmatter.title : '';

-  const slug = slugify(`${date} ${title}`, { lower: true });
+  const slug = slugify(`${date} ${title}`, { lower: true, strict: true });


I did add "strict" to the slugify to make sure e.g. not parantheses and other characters are in the URL to have them consistent with all existing URLs.

packages/gatsby-theme-docs/gatsby-config.js

+                }
+              }
+            `,
+              output: '/release-notes.xml',


obsolete

…ng for html node

…rom website

…o last in all cases

nkuehn

I implemented the open topics, good to go now from my side

…ools-docs-kit into rss-feed

emmenko · 2020-04-16T10:02:29Z

websites/docs-smoke-test/gatsby-config.js

@@ -12,9 +12,9 @@ module.exports = {
    {
      resolve: '@commercetools-docs/gatsby-theme-docs',
      options: {
+        title: 'Docs Smoke Test',


This is also duplicated

Yea, not quite sure what the alternative would look like yet.

We could "move" the siteMetadata as a theme plugin option, then spread the value in the theme gatsby-config.js as we have some defaults for siteMetadata.

This would be a breaking change though.

I'm looking to override the title in the setup field of the plugin, where we have access to siteMetadata.

https://www.gatsbyjs.org/docs/adding-an-rss-feed/#syntax-for-itunes-rss-blocks

But I see that the feed's global title is the same as the description, I'll try to fix that but it seems it's just a workaround as this behaviour is probably a bug in the plugin.

@emmenko we just refactored the way the options are read, no duplicates any more

Thanks, I like the setup approach. The configuration has still an error though (see CI)

…iption and link of the channel are generated

davifantasia · 2020-04-16T10:53:07Z

packages/gatsby-theme-docs/gatsby-config.js

+            }
+          }
+        `,
+          setup: (options) => {


We can override the site title here to customize with title from siteMetadata.

But the link and description of the channel in the generated xml are lost once setup is implemented. Even when I tested with just returning the option parameter.

You need to spread the options like this: https://github.com/gatsbyjs/gatsby/blob/055844312b8e681673fd453a8a556693eabb7ac1/packages/gatsby-plugin-feed/src/internals.js#L29-L39

emmenko

According to the default implementation, we should also spread siteMetadata, not just the options

packages/gatsby-theme-docs/gatsby-config.js

emmenko

Awesome! 💯

feat: release notes setup, still needs to configure content by queryi…

9dd24b8

…ng for html node

davifantasia added the 🚀 Type: New Feature Something new label Apr 14, 2020

Merge branch 'master' of https://github.com/commercetools/commercetoo…

0458944

…ls-docs-kit into rss-feed

vercel bot temporarily deployed to Preview April 14, 2020 14:37 Inactive

emmenko reviewed Apr 14, 2020

View reviewed changes

nkuehn reviewed Apr 14, 2020

View reviewed changes

refactor: code review suggestions

5b9709a

vercel bot temporarily deployed to Preview April 15, 2020 09:28 Inactive

davifantasia marked this pull request as ready for review April 15, 2020 09:31

davifantasia requested a review from emmenko April 15, 2020 09:31

refactor: query for path prefix instead of passing another variable f…

b2436e4

…rom website

vercel bot temporarily deployed to Preview April 15, 2020 16:04 Inactive

nkuehn self-requested a review April 15, 2020 19:30

vercel bot temporarily deployed to Preview April 15, 2020 19:30 Inactive

nkuehn previously requested changes Apr 15, 2020

View reviewed changes

emmenko reviewed Apr 15, 2020

View reviewed changes

This comment has been minimized.

Sign in to view

vercel bot temporarily deployed to Preview April 15, 2020 19:59 Inactive

davifantasia and others added 7 commits April 15, 2020 22:02

feat: release notes setup, still needs to configure content by queryi…

7514019

…ng for html node

refactor: code review suggestions

b5278fe

refactor: query for path prefix instead of passing another variable f…

e4417af

…rom website

build(smoke-test): yarn script to build and serve without postbuild

f7d4f4e

fix(rss): strict slugify for more compatible urls with old site

cd9f76a

feat(rss): add release note topics as categories

be48662

fix(smoke-test): remove unused theme option

75ccb5b

Nikolaus Kühn added 2 commits April 15, 2020 22:02

enhancement(rss): more conventional and consistent feed location

5338da3

fix(rss): move feed generator plugin above the plugins that need to g…

3291c8e

…o last in all cases

nkuehn force-pushed the rss-feed branch from ce59d15 to 3291c8e Compare April 15, 2020 20:04

vercel bot temporarily deployed to Preview April 15, 2020 20:04 Inactive

nkuehn approved these changes Apr 15, 2020

View reviewed changes

davifantasia added 3 commits April 16, 2020 11:01

refactor: now generating siteurl field using createresolvers api

570d3ef

Merge branch 'rss-feed' of https://github.com/commercetools/commercet…

6e81588

…ools-docs-kit into rss-feed

refactor: after pull refactor

1ab3799

vercel bot temporarily deployed to Preview April 16, 2020 09:22 Inactive

emmenko reviewed Apr 16, 2020

View reviewed changes

refactor: overriding site in setup api of plugin, but the wrong descr…

28a3efa

…iption and link of the channel are generated

vercel bot temporarily deployed to Preview April 16, 2020 10:49 Inactive

davifantasia commented Apr 16, 2020

View reviewed changes

refactor(rss): initialize all rss options in the plugin setup function

3dbf095

vercel bot had a problem deploying to Preview April 16, 2020 11:28 Failure

fix: build failure

4487b13

vercel bot temporarily deployed to Preview April 16, 2020 11:46 Inactive

emmenko requested changes Apr 16, 2020

View reviewed changes

packages/gatsby-theme-docs/gatsby-config.js Outdated Show resolved Hide resolved

refactor: including recommended values returned in setup

50742f2

vercel bot temporarily deployed to Preview April 16, 2020 11:57 Inactive

davifantasia requested a review from emmenko April 16, 2020 12:00

emmenko approved these changes Apr 16, 2020

View reviewed changes

davifantasia merged commit 6e980ef into master Apr 16, 2020

davifantasia deleted the rss-feed branch April 16, 2020 12:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: generate rss feed #364

feat: generate rss feed #364

davifantasia commented Apr 14, 2020

vercel bot commented Apr 14, 2020 •

edited

Loading

emmenko Apr 14, 2020

This comment was marked as resolved.

This comment was marked as resolved.

nkuehn left a comment

This comment was marked as resolved.

nkuehn Apr 14, 2020

nkuehn Apr 14, 2020

nkuehn Apr 14, 2020 •

edited

Loading

nkuehn Apr 14, 2020

nkuehn Apr 14, 2020

nkuehn left a comment

nkuehn Apr 15, 2020

nkuehn Apr 15, 2020

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment has been minimized.

This comment has been minimized.

nkuehn left a comment

emmenko Apr 16, 2020

davifantasia Apr 16, 2020

emmenko Apr 16, 2020

davifantasia Apr 16, 2020 •

edited

Loading

nkuehn Apr 16, 2020

emmenko Apr 16, 2020

davifantasia Apr 16, 2020 •

edited

Loading

emmenko Apr 16, 2020

emmenko left a comment

emmenko left a comment

		betaLink: null,
		siteUrl: `https://${productionHostname}/${pluginOptions.websiteKey}`,

feat: generate rss feed #364

feat: generate rss feed #364

Conversation

davifantasia commented Apr 14, 2020

vercel bot commented Apr 14, 2020 • edited Loading

Choose a reason for hiding this comment

This comment was marked as resolved.

This comment was marked as resolved.

nkuehn left a comment

Choose a reason for hiding this comment

This comment was marked as resolved.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nkuehn Apr 14, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nkuehn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment has been minimized.

This comment has been minimized.

nkuehn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

davifantasia Apr 16, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

davifantasia Apr 16, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

emmenko left a comment

Choose a reason for hiding this comment

emmenko left a comment

Choose a reason for hiding this comment

vercel bot commented Apr 14, 2020 •

edited

Loading

nkuehn Apr 14, 2020 •

edited

Loading

davifantasia Apr 16, 2020 •

edited

Loading

davifantasia Apr 16, 2020 •

edited

Loading