feat(plugin-blog): multi-authors support + authors.yml global configuration #5396

Josh-Cena · 2021-08-20T15:22:56Z

Motivation

Resolve #5363.

Add new authors frontmatter + recommend it over author _* legacy frontmatter (much more flexible)
Supports single/multiple authors
Allow referencing authors data from a global authors.yml file
Allow local (per blog posts) override of authors.yml data
The authors.yml file can be localized
Refactor templates, docs, and examples with new authors frontmatter
Improve init template blog posts

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

Unit tests

Dogfood:

Docs:

netlify · 2021-08-20T15:29:46Z

✔️ [V2]
Built without sensitive environment variables

🔨 Explore the source changes: 11be61e

🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/611fc8d1f17e8000079a075d

😎 Browse the preview: https://deploy-preview-5396--docusaurus-2.netlify.app

github-actions · 2021-08-20T15:29:55Z

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🟠 Performance	64
🟢 Accessibility	98
🟢 Best practices	100
🟢 SEO	100
🟢 PWA	95

Lighthouse ran on https://deploy-preview-5396--docusaurus-2.netlify.app/

github-actions · 2021-08-20T15:29:55Z

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🟢 Performance	98
🟢 Accessibility	98
🟢 Best practices	100
🟢 SEO	100
🟢 PWA	95

Lighthouse ran on https://deploy-preview-5396--docusaurus-2.netlify.app/

netlify · 2021-08-20T15:35:32Z

✔️ [V2]

🔨 Explore the source changes: 01fa677

🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/612767f9c4b1ed0007e9a094

😎 Browse the preview: https://deploy-preview-5396--docusaurus-2.netlify.app

slorber

Looks like a nice start! Thanks

packages/docusaurus-plugin-content-blog/package.json

packages/docusaurus-plugin-content-blog/src/blogFrontMatter.ts

slorber · 2021-08-20T16:23:26Z

packages/docusaurus-plugin-content-blog/src/blogUtils.ts

@@ -100,6 +103,60 @@ function formatBlogPostDate(locale: string, date: Date): string {
  }
 }

+type AuthorMap = Record<string, Author>;
+
+async function readAuthorListFile(


As we have similar code in the docs plugin, we could extract some utility function that could read from js/yaml in a generic way?

Like readConfigFile("blog/authors",schema)

In fact the YAML parser should be able to parse JSON because YAML is a superset of JSON. Should I make that refactor here?

yes discovered that recently 🤪

I'll do it and try to merge this PR asap.

Maybe not entirely true? https://stackoverflow.com/questions/21584985/what-valid-json-files-are-not-valid-yaml-1-1-files

I ended up not doing it because at least it works right now

packages/docusaurus-plugin-content-blog/src/blogUtils.ts

packages/docusaurus-plugin-content-blog/src/pluginOptionSchema.ts

packages/docusaurus-plugin-content-blog/src/blogUtils.ts

packages/docusaurus-theme-classic/src/theme/BlogPostItem/index.tsx

packages/docusaurus-plugin-content-blog/src/blogUtils.ts

Josh-Cena · 2021-08-22T10:34:37Z

It would be cool if we can either deprecate Bootstrap theme or actually maintain it 😅 Really awkward to make type check pass while at runtime it would actually break

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

packages/docusaurus-theme-classic/src/theme/BlogPostAuthors/index.tsx

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

packages/docusaurus-mdx-loader/src/index.ts

packages/docusaurus-theme-classic/src/theme/BlogPostAuthors/index.tsx

packages/docusaurus-theme-classic/src/theme/BlogPostAuthor/styles.module.css

See facebook/docusaurus#5396.

yzeng25 · 2021-12-08T09:34:06Z

Thank you for implementing this feature! It is really helpful for bilingual blog maintenance in https://apisix.apache.org/blog, where technical writers and translators need to get involved in the documents, and they deserve the credit.

Josh-Cena requested review from lex111 and slorber as code owners August 20, 2021 15:22

facebook-github-bot added the CLA Signed Signed Facebook CLA label Aug 20, 2021

Josh-Cena force-pushed the blog-author-profile branch from 11be61e to 6256e64 Compare August 20, 2021 15:26

slorber requested changes Aug 20, 2021

View reviewed changes

Josh-Cena marked this pull request as draft August 21, 2021 02:16

Josh-Cena force-pushed the blog-author-profile branch from 411a07a to 1795027 Compare August 22, 2021 14:49

Josh-Cena marked this pull request as ready for review August 23, 2021 03:38

Josh-Cena force-pushed the blog-author-profile branch 2 times, most recently from 5c2bd41 to 95a0dde Compare August 23, 2021 07:28

This comment has been minimized.

Sign in to view

Josh-Cena added 13 commits August 23, 2021 18:24

Complete function

12300d6

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

A lot of blank lines

d59705c

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

More lenient validation

f60b983

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

Remove or

7e6385f

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

Simpler logic

52ca0e2

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

Expand docs

4a25295

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

Better docs

5639c3c

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

Dogfood

20a71af

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

More writeup

a11ddd4

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

Polish

f46ad01

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

Polish

32d5604

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

Move mergeAuthorMap to authors.ts

567ea2c

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

Unbreak relative assets

c92dede

Josh-Cena force-pushed the blog-author-profile branch from 6765fe3 to c92dede Compare August 23, 2021 10:24

slorber added 9 commits August 25, 2021 17:31

add tests for getAuthorsMapFilePath

c55dd22

tests for validateAuthorsMapFile

e6fb255

add tests for readAuthorsMapFile

2f26c78

test getAuthorsMap

66998cb

exhaustive tests for getBlogPostAuthors

5083531

fix remaining tests

a4ecc4c

missing blog plugin author tests

3b11620

fix windows tests

e526ab5

improve blog multi-author's doc

d16d7b9

slorber changed the title ~~feat(plugin-blog): global blog author profile list~~ feat(plugin-blog): Add multi-authors support + authors.yml global configuration Aug 25, 2021

slorber added the pr: new feature This PR adds a new API or behavior. label Aug 25, 2021

lex111 reviewed Aug 25, 2021

View reviewed changes

packages/docusaurus-theme-classic/src/theme/BlogPostAuthors/index.tsx Outdated Show resolved Hide resolved

Josh-Cena added 2 commits August 26, 2021 08:33

Use new format in init template

f2f5710

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

Improve error message

5e5c514

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

Josh-Cena changed the title ~~feat(plugin-blog): Add multi-authors support + authors.yml global configuration~~ feat(plugin-blog): multi-authors support + authors.yml global configuration Aug 26, 2021

slorber and others added 6 commits August 26, 2021 09:56

update feed snapshot

10bcb47

blog authors: limit to 2 cols + fix margins for no authors

0a9b902

minor doc improvements

c4fb05c

better init template blog posts, demonstrating Blog features

3ad2339

replace the legacy blog author frontmatter in remaining places

2159cda

Prefer using clsx

c9882ea

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

slorber approved these changes Aug 26, 2021

View reviewed changes

packages/docusaurus-mdx-loader/src/index.ts Show resolved Hide resolved

packages/docusaurus-theme-classic/src/theme/BlogPostAuthors/index.tsx Outdated Show resolved Hide resolved

lex111 reviewed Aug 26, 2021

View reviewed changes

packages/docusaurus-theme-classic/src/theme/BlogPostAuthor/styles.module.css Outdated Show resolved Hide resolved

slorber added 2 commits August 26, 2021 12:07

cleanup getColClassName

1eb9c3f

remove blog author name/title line-clamping

01fa677

slorber merged commit 493225a into facebook:main Aug 26, 2021

Josh-Cena deleted the blog-author-profile branch August 26, 2021 10:25

charleskorn added a commit to batect/batect.dev that referenced this pull request Aug 27, 2021

Define blog post authors in one place.

3c3e869

See facebook/docusaurus#5396.

swyxio mentioned this pull request Sep 2, 2021

beta.5 docs tags feature - better validation for malformed tags #5478

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(plugin-blog): multi-authors support + authors.yml global configuration #5396

feat(plugin-blog): multi-authors support + authors.yml global configuration #5396

Josh-Cena commented Aug 20, 2021 •

edited by slorber

Loading

netlify bot commented Aug 20, 2021

github-actions bot commented Aug 20, 2021 •

edited

Loading

github-actions bot commented Aug 20, 2021

netlify bot commented Aug 20, 2021 •

edited

Loading

slorber left a comment

slorber Aug 20, 2021

Josh-Cena Aug 23, 2021

slorber Aug 24, 2021

Josh-Cena Aug 24, 2021

Josh-Cena commented Aug 22, 2021

This comment has been minimized.

yzeng25 commented Dec 8, 2021

feat(plugin-blog): multi-authors support + authors.yml global configuration #5396

feat(plugin-blog): multi-authors support + authors.yml global configuration #5396

Conversation

Josh-Cena commented Aug 20, 2021 • edited by slorber Loading

Motivation

Have you read the Contributing Guidelines on pull requests?

Test Plan

netlify bot commented Aug 20, 2021

github-actions bot commented Aug 20, 2021 • edited Loading

github-actions bot commented Aug 20, 2021

netlify bot commented Aug 20, 2021 • edited Loading

slorber left a comment

Choose a reason for hiding this comment

slorber Aug 20, 2021

Choose a reason for hiding this comment

Josh-Cena Aug 23, 2021

Choose a reason for hiding this comment

slorber Aug 24, 2021

Choose a reason for hiding this comment

Josh-Cena Aug 24, 2021

Choose a reason for hiding this comment

Josh-Cena commented Aug 22, 2021

This comment has been minimized.

yzeng25 commented Dec 8, 2021

Josh-Cena commented Aug 20, 2021 •

edited by slorber

Loading

github-actions bot commented Aug 20, 2021 •

edited

Loading

netlify bot commented Aug 20, 2021 •

edited

Loading