feat(blog): authors page #10216

OzakIOne · 2024-06-13T13:42:17Z

Pre-flight checklist

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

#10196

Retro compatible with old system
- If feature is disabled, author link is his url
- Else author link is author's page
Does not create a authors page for inline authors
feat(blog): author header social icons #10222
feat(blog): warn duplicate and inline authors #10224

Todo

questions above ^
questions in the RFC
fix todos 🙃
write and fix tests
polish authors page UI ?
fix swizzle ci

Test Plan

Dogfood, unit tests, E2E
- enable argos at the end

Test links

Authors: https://deploy-preview-10216--docusaurus-2.netlify.app/blog/authors
Slorber author: https://deploy-preview-10216--docusaurus-2.netlify.app/blog/authors/slorber

Related issues/PRs

Fix #10196

github-actions · 2024-06-13T13:48:53Z

⚡️ Lighthouse report for the deploy preview of this PR

URL	Performance	Accessibility	Best Practices	SEO	PWA	Report
/	🟠 88	🟢 98	🟢 96	🟢 100	🟠 88	Report
/docs/installation	🟠 64	🟢 96	🟢 100	🟢 100	🟠 88	Report
/docs/category/getting-started	🟠 75	🟢 100	🟢 100	🟢 90	🟠 88	Report
/blog	🟠 69	🟢 100	🟢 100	🟢 90	🟠 88	Report
/blog/preparing-your-site-for-docusaurus-v3	🟠 64	🟢 96	🟢 100	🟢 100	🟠 88	Report
/blog/tags/release	🟠 71	🟢 100	🟢 100	🟢 90	🟠 88	Report
/blog/tags	🟠 75	🟢 100	🟢 100	🟢 90	🟠 88	Report

netlify · 2024-06-13T13:58:49Z

✅ [V2]

Name	Link
🔨 Latest commit	`6b62c98`
🔍 Latest deploy log	https://app.netlify.com/sites/docusaurus-2/deploys/667b275b99887800087082af
😎 Deploy Preview	https://deploy-preview-10216--docusaurus-2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

github-actions · 2024-06-13T14:05:12Z

Size Change: +14 kB (+0.76%)

Total Size: 1.86 MB

Filename	Size	Change
`website/.docusaurus/docusaurus.config.mjs`	27.2 kB	+96 B (+0.35%)
`website/.docusaurus/registry.js`	308 kB	+3.81 kB (+1.25%)
`website/.docusaurus/routes.js`	203 kB	+1.28 kB (+0.63%)
`website/.docusaurus/routesChunkNames.json`	133 kB	+3.27 kB (+2.52%)
`website/build/assets/css/styles.********.css`	113 kB	+201 B (+0.18%)
`website/build/assets/js/main.********.js`	912 kB	+5.36 kB (+0.59%)

ℹ️ View Unchanged

Filename	Size
`website/.docusaurus/codeTranslations.json`	2 B
`website/.docusaurus/globalData.json`	123 kB
`website/.docusaurus/i18n.json`	930 B
`website/.docusaurus/site-metadata.json`	2.17 kB
`website/build/index.html`	38.1 kB

_{compressed-size-action}

OzakIOne · 2024-06-20T15:02:34Z

Not sure about this poc refactor 5c789b3 (#10216)
It has some side effects on the tests in index.test.ts

lastUpdatedAt: undefined,
lastUpdatedBy: undefined,

The filter of the page author is now done in getPageAuthor instead of normalizeAuthor

So now we normalize all authors, and for the pageAuthor, we get only the authors with a generatePage === true

Is it better like this or the way before ? 🤷

This reverts commit 5c789b3.

slorber

First review pass

packages/docusaurus-utils/src/authors.ts

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

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

slorber · 2024-06-21T12:59:27Z

packages/docusaurus-theme-classic/src/theme/BlogAuthorPage/AuthorsListByLetter/index.tsx

+}
+
+export default function AuthorsListByLetter({authors}: Props): JSX.Element {
+  const letterList = listAuthorsByLetters(authors);


I wonder if we should group authors by letters. We should probably ask the community but it's also possible to list authors as a simple alphabetical line.

Similar to:
https://react.dev/community/team

To me it's unlikely authors will grow as fast as tags. But both options are valid, we can keep it this way for now.

Also: how do we handle authors that have no name? 😅

I wonder if we should group authors by letters.

It would look like this:

https://cronica-it.github.io/evenimente/autori/

To me it's unlikely authors will grow as fast as tags.

In an historical site like mine, it is highly likely that each new contribution will come from a new author.

how do we handle authors that have no name

Good question, it gave me quite some headaches; in the end I added a new object, NamedAuthors.

@ilg-ul we can't take your site as an example for this feature because we are building a blog plugin, not a chronological site. We enable you to render the list the way you want with swizzling, but it doesn't mean it's what we should provide by default for people that are actually building blogs.

However I'm fine with the current UI, it's not awesome but good enough to ship:
https://deploy-preview-10216--docusaurus-2.netlify.app/blog/authors

Important to note that we only list authors on this page coming from authors.yml. Inline authors won't appear there.

The look is not relevant; the functionality seems equivalent (even better), so no problems so far.

Also no problems to ignore inline authors.

slorber · 2024-06-21T13:01:28Z

packages/docusaurus-theme-common/src/utils/authorsUtils.ts

+};
+
+function getAuthorLetter(author: string): string {
+  return author[0]!.toUpperCase();


What about authors without a name?

For now authors without names are named internaly with their key

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

Line 244 in 0a35323

const name = author.name || key;

So the route and the list of authors by letters are done with the key

slorber · 2024-06-21T13:03:23Z

packages/docusaurus-theme-classic/src/theme/BlogAuthorPage/BlogAuthorsPostsPage/index.tsx

+function useBlogPostsPlural() {
+  const {selectMessage} = usePluralForm();
+  return (count: number) =>
+    selectMessage(
+      count,
+      translate(
+        {
+          id: 'theme.blog.post.plurals',
+          description:
+            'Pluralized label for "{count} posts". Use as much plural forms (separated by "|") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)',
+          message: 'One post|{count} posts',
+        },
+        {count},
+      ),
+    );
+}


Duplicated, need to be factorized. Since it's not related to styling, it can be moved to theme-common (same for all translation methods btw)

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

packages/docusaurus-theme-common/src/utils/authorsUtils.ts

OzakIOne · 2024-06-25T20:23:24Z

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

+      title: Joi.string(),
+      email: Joi.string(),
+      page: Joi.alternatives(Joi.bool(), AuthorPageSchema),
+      permalink: Joi.string(),


We allow bool or AuthorPageSchema, however the type definition of page is null or AuthorPageSchema, tests throws page should be boolean or AuthorPage, else TS yells page to be null

feat(blog): authors page

269eaaa

facebook-github-bot added the CLA Signed Signed Facebook CLA label Jun 13, 2024

fix build

f734a90

refactor: apply lint autofix

29b3a64

OzakIOne and others added 22 commits June 14, 2024 12:51

fix typo

f1a4427

refactor: apply lint autofix

1792c78

fix tests

e1c0e5e

fix tests

20e5f29

fix typecheck

d018eb6

update styles

f29b69a

fix test?

cb4cc78

revert

6e66bc7

remove socials & support unnamed author

fc7f7d0

remove duplication and inline check

cac2f99

feat: permalink support

65db409

feat: author description

a6dbf71

spread properties

2f725cb

refactor

8bf3e4f

refactor: image base url

2f69b6d

refactor: types

80f368a

style: use blog post author ui

574d45a

fix bug when permalink is other author key with slash

ff32178

refactor

d4f892f

refactor: apply lint autofix

788b198

refactor

16b0dbf

refactor remove pageAuthor prop, use author instead

5c789b3

Revert "refactor remove pageAuthor prop, use author instead"

151f49f

This reverts commit 5c789b3.

slorber requested changes Jun 21, 2024

View reviewed changes

OzakIOne mentioned this pull request Jun 21, 2024

feat(blog): warn duplicate and inline authors #10224

Draft

3 tasks

OzakIOne and others added 7 commits June 23, 2024 22:21

move authorsUtils to blog

0a35323

Merge branch 'main' into ozaki/mediaShareButtons

ce545b0

Refactor blog author pages code and types

da37991

move useBlogPostsPlural & listByLetters

d6df47c

move for consistency with tags components

6258f80

update theme path

cf5f2ea

fix test

6fcd67f

OzakIOne commented Jun 25, 2024

View reviewed changes

fix tests

6b62c98

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(blog): authors page #10216

feat(blog): authors page #10216

OzakIOne commented Jun 13, 2024 •

edited

Loading

github-actions bot commented Jun 13, 2024 •

edited

Loading

netlify bot commented Jun 13, 2024 •

edited

Loading

github-actions bot commented Jun 13, 2024 •

edited

Loading

OzakIOne commented Jun 20, 2024 •

edited

Loading

slorber left a comment

slorber Jun 21, 2024

ilg-ul Jun 21, 2024

slorber Jun 21, 2024

ilg-ul Jun 21, 2024

slorber Jun 21, 2024

OzakIOne Jun 23, 2024

slorber Jun 21, 2024

OzakIOne Jun 25, 2024

feat(blog): authors page #10216

Are you sure you want to change the base?

feat(blog): authors page #10216

Conversation

OzakIOne commented Jun 13, 2024 • edited Loading

Pre-flight checklist

Motivation

Todo

Test Plan

Test links

Related issues/PRs

github-actions bot commented Jun 13, 2024 • edited Loading

⚡️ Lighthouse report for the deploy preview of this PR

netlify bot commented Jun 13, 2024 • edited Loading

✅ [V2]

github-actions bot commented Jun 13, 2024 • edited Loading

OzakIOne commented Jun 20, 2024 • edited Loading

slorber 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

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

Choose a reason for hiding this comment

OzakIOne commented Jun 13, 2024 •

edited

Loading

github-actions bot commented Jun 13, 2024 •

edited

Loading

netlify bot commented Jun 13, 2024 •

edited

Loading

github-actions bot commented Jun 13, 2024 •

edited

Loading

OzakIOne commented Jun 20, 2024 •

edited

Loading