feat: add "unlisted" front matter option for blog posts #1396

olafurpg · 2019-04-26T09:14:05Z

Previously, the blog sidebar listed the most recent blog posts sorted by
their publish date. This commit adds the ability to hide a specific blog
post from the sidebar and the feed of all blog posts by adding the
unlisted: true header option.

Fixes #1393.

Motivation

The motivation for this feature is to make it possible to change dates of published posts without breaking the old URL (which might be widely shared).

Concrete example, we published a blog post two weeks ago that is dated for 2020 (https://scalameta.org/metals/blog/2020/04/12/mercury.html). We have closed three PRs fixing the date (scalameta/metals#683, scalameta/metals#670, scalameta/metals#656) but they have all been closed because changing the date of the post would turn the old URL into a 404.

With the ability to unlist posts, I could unlist the 2020 post, create a new posts dated in 2019 and update the unlisted 2020 post to forward to the new 2019 post.

I'm open for alternative solutions to fix that particular problem. I think unlisting is a flexible solution that could be useful in other situations as well, for example when writing a draft post.

Have you read the Contributing Guidelines on pull requests?

Yes.

Test Plan

I would appreciate help for testing this change since I'm unfamiliar with jest (and JavaScript in general 😅 ). I created a blog post in __test__/__fixtures__ using unlisted: true and ran yarn test and everything passed but I expected some snapshot tests to fail.

I tested the change manually on our website and it seems to work as expected:

Observe that uncommenting unlisted: true makes the post disappear from both the sidebar and the list of all blog posts while the post is still published under the unchanged URL.

Related PRs

I'm not aware of any.

docusaurus-bot · 2019-04-26T09:15:56Z

Deploy preview for docusaurus-2 ready!

Built with commit 031c2cb

https://deploy-preview-1396--docusaurus-2.netlify.com

docusaurus-bot · 2019-04-26T09:17:49Z

Deploy preview for docusaurus-preview ready!

Built with commit 031c2cb

https://deploy-preview-1396--docusaurus-preview.netlify.com

Previously, the blog sidebar listed the most recent blog posts sorted by their publish date. This commit adds the ability to hide a specific blog post from the sidebar and the feed of all blog posts by adding the `unlisted: true` header option. ```md title: My Draft Post unlisted: true # Hide from blog sidebar and main blog page feed. --- ```

olafurpg · 2019-04-26T09:22:33Z

packages/docusaurus-1.x/lib/core/BlogPageLayout.js

@@ -10,6 +10,8 @@ const BlogPost = require('./BlogPost.js');
 const BlogSidebar = require('./BlogSidebar.js');
 const Container = require('./Container.js');
 const MetadataBlog = require('./MetadataBlog.js');
+
+const MetadataPublicBlog = MetadataBlog.filter(item => item.unlisted !== true);


Where would be a good place to put this shared logic between BlogSidebar.js, BlogPageLayout.js and feed.js?

packages/docusaurus-1.x/lib/core/BlogPageLayout.js

gabro · 2019-04-26T09:30:22Z

packages/docusaurus-1.x/lib/core/BlogPageLayout.js

@@ -10,6 +10,8 @@ const BlogPost = require('./BlogPost.js');
 const BlogSidebar = require('./BlogSidebar.js');
 const Container = require('./Container.js');
 const MetadataBlog = require('./MetadataBlog.js');
+
+const MetadataPublicBlog = MetadataBlog.filter(item => item.unlisted !== true);


Suggested change

const MetadataPublicBlog = MetadataBlog.filter(item => item.unlisted !== true);

const MetadataPublicBlog = MetadataBlog.filter(item => !item.unlisted);

yangshun

The change looks good in general, but I'd like to suggest that draft: true could be a better naming than unlisted: true. Jekyll calls them drafts too.

Is there currently a way for you to view your unlisted/draft posts without toggling the flag?

In v2 we should definitely support this feature and allow a command line flag or config option on whether to display them during development.

NishealJ · 2019-04-28T19:22:09Z

packages/docusaurus-1.x/lib/server/feed.js

@@ -28,6 +28,9 @@ module.exports = function(type) {

  readMetadata.generateMetadataBlog();
  const MetadataBlog = require('../core/MetadataBlog.js');
+  const MetadataPublicBlog = MetadataBlog.filter(
+    item => item.unlisted !== true,


item => !item.unlisted,

olafurpg · 2019-04-29T12:26:23Z

Thank you for the review! I've renamed "unlisted" into "draft" and incorporated the !item.draft refactoring. Note that there is a difference between draft posts in Jekyll and how they are implemented in this PR.

Jekyll draft posts are ignored during a non-development build and they do not need a date in the filename
draft posts in this PR still require a date in the filename and are published during non-development builds, they just don't appear in the blog sidebar or main blog feed

Is there currently a way for you to view your unlisted/draft posts without toggling the flag?

Not in the current implementation. It would be nice to see draft posts during livereload development but I'm not sure how to implement that.

gabro · 2019-04-29T12:32:55Z

About unlisted vs draft. The way I would expect "draft" to behave is not to make the post public, whereas unlisted would be published but not listed in the menu.

To summarize

status	visible in menu	published
draft	no	no
unlisted	no	yes
normal	yes	yes

For this reason, I think 'unlisted' was the appropriate name for the changes included in this PR.

olafurpg · 2019-06-11T12:25:28Z

Anything I can do to help unblock this issue? All of the review comments from #1396 (review) have been addressed, although I believe it's worth considering using unlisted instead of draft due to the reasons mentioned by @gabro in #1396 (comment)

endiliey · 2019-06-14T04:58:02Z

cc @yangshun @wgao19

yangshun

@olafurpg Sorry for the late reply. @gabro's comment convinced me that unlisted sounds more appropriate although I'm not leaning strongly towards any particular term. Medium is essentially doing something similar. I'll merge this and make the changes myself since I was the one who asked for the bad change 😅

olafurpg requested a review from endiliey as a code owner April 26, 2019 09:14

facebook-github-bot added the CLA Signed Signed Facebook CLA label Apr 26, 2019

olafurpg force-pushed the hide-from-blog-sidebar branch from 27f22c2 to 26aee90 Compare April 26, 2019 09:21

olafurpg commented Apr 26, 2019

View reviewed changes

olafurpg mentioned this pull request Apr 26, 2019

Add option to unlist blog post from sidebar #1393

Closed

gabro reviewed Apr 26, 2019

View reviewed changes

yangshun suggested changes Apr 26, 2019

View reviewed changes

NishealJ reviewed Apr 28, 2019

View reviewed changes

Rename "unlisted" into "draft".

031c2cb

endiliey assigned yangshun May 1, 2019

yangshun approved these changes Jun 15, 2019

View reviewed changes

yangshun changed the title ~~Add unlisted header option for blog posts, fixes #1393.~~ feat: add unlisted header option for blog posts Jun 15, 2019

yangshun changed the title ~~feat: add unlisted header option for blog posts~~ feat: add "unlisted" front matter option for blog posts Jun 15, 2019

yangshun merged commit da3c913 into facebook:master Jun 15, 2019

olafurpg deleted the hide-from-blog-sidebar branch June 15, 2019 20:53

slorber mentioned this pull request Aug 18, 2020

V2: blog "draft" frontmatter #3305

Closed

MattiaPrimavera mentioned this pull request Oct 9, 2021

Draft feature for Doc Pages Frontmatter #3417

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add "unlisted" front matter option for blog posts #1396

feat: add "unlisted" front matter option for blog posts #1396

olafurpg commented Apr 26, 2019 •

edited by yangshun

Loading

docusaurus-bot commented Apr 26, 2019 •

edited

Loading

docusaurus-bot commented Apr 26, 2019 •

edited

Loading

olafurpg Apr 26, 2019

gabro Apr 26, 2019

olafurpg Apr 29, 2019

yangshun left a comment

NishealJ Apr 28, 2019

olafurpg Apr 29, 2019

olafurpg commented Apr 29, 2019

gabro commented Apr 29, 2019 •

edited

Loading

olafurpg commented Jun 11, 2019

endiliey commented Jun 14, 2019

yangshun left a comment

	const MetadataPublicBlog = MetadataBlog.filter(item => item.unlisted !== true);
	const MetadataPublicBlog = MetadataBlog.filter(item => !item.unlisted);

feat: add "unlisted" front matter option for blog posts #1396

feat: add "unlisted" front matter option for blog posts #1396

Conversation

olafurpg commented Apr 26, 2019 • edited by yangshun Loading

Motivation

Have you read the Contributing Guidelines on pull requests?

Test Plan

Related PRs

docusaurus-bot commented Apr 26, 2019 • edited Loading

docusaurus-bot commented Apr 26, 2019 • edited Loading

olafurpg Apr 26, 2019

Choose a reason for hiding this comment

gabro Apr 26, 2019

Choose a reason for hiding this comment

olafurpg Apr 29, 2019

Choose a reason for hiding this comment

yangshun left a comment

Choose a reason for hiding this comment

NishealJ Apr 28, 2019

Choose a reason for hiding this comment

olafurpg Apr 29, 2019

Choose a reason for hiding this comment

olafurpg commented Apr 29, 2019

gabro commented Apr 29, 2019 • edited Loading

olafurpg commented Jun 11, 2019

endiliey commented Jun 14, 2019

yangshun left a comment

Choose a reason for hiding this comment

olafurpg commented Apr 26, 2019 •

edited by yangshun

Loading

docusaurus-bot commented Apr 26, 2019 •

edited

Loading

docusaurus-bot commented Apr 26, 2019 •

edited

Loading

gabro commented Apr 29, 2019 •

edited

Loading