feat(pages): add LastUpdateAuthor & LastUpdateTime & editUrl #10032

OzakIOne · 2024-04-09T15:59:04Z

Motivation

Provide two options in pages showLastUpdateAuthor, showLastUpdateTime and editUrl which like in docs, show the time the page was last updated and also who updated it

This only works for markdown pages

pages: {
  editUrl: ({locale, pagesPath}) => {
    if (locale !== defaultLocale) {
      return `https://crowdin.com/project/docusaurus-v2/${locale}`;
    }
    return `https://github.com/facebook/docusaurus/edit/main/website/src/pages/${pagesPath}`;
  },
  showLastUpdateAuthor: true,
  showLastUpdateTime: true,
}

Test Plan

Deploy, tests, dogfood

Test links

Deploy preview: https://deploy-preview-10032--docusaurus-2.netlify.app/tests

Related issues/PRs

#9954

netlify · 2024-04-09T16:01:57Z

✅ [V2]

Name	Link
🔨 Latest commit	`287bf0b`
🔍 Latest deploy log	https://app.netlify.com/sites/docusaurus-2/deploys/661d5e1e3addcc0008ea79da
😎 Deploy Preview	https://deploy-preview-10032--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-04-09T16:05:25Z

⚡️ Lighthouse report for the deploy preview of this PR

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

github-actions · 2024-04-09T16:09:22Z

Size Change: +157 B (0%)

Total Size: 1.05 MB

Filename	Size	Change
`website/build/assets/js/main.********.js`	811 kB	+157 B (0%)

ℹ️ View Unchanged

Filename	Size
`website/.docusaurus/globalData.json`	91.2 kB
`website/build/assets/css/styles.********.css`	113 kB
`website/build/index.html`	38 kB

_{compressed-size-action}

argos-ci · 2024-04-11T16:33:20Z

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build	Status	Details	Updated (UTC)
default (Inspect)	🧿 Changes detected (Review)	3 changed	Apr 15, 2024, 5:13 PM

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

slorber

Looks almost ready, but:

need to also support editUrl 🎁
need docs
need unit tests + fix existing snapshots
need to dogfood

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

packages/docusaurus-plugin-content-pages/src/index.ts

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

slorber

Almost good!

Would like to test this on the dogfood plugins too, meta row UI should appear on these pages:

https://deploy-preview-10032--docusaurus-2.netlify.app/tests/pages/

slorber · 2024-04-12T10:23:56Z

packages/docusaurus-plugin-content-pages/src/index.ts

+        function getPagesEditUrl() {
+          const pagesPathRelative = path.relative(
+            pagesDirPath,
+            path.resolve(pagesSourceAbsolute),
+          );
+
+          if (typeof editUrl === 'function') {
+            return editUrl({
+              pagesDirPath: posixPath(path.relative(siteDir, pagesDirPath)),
+              pagesPath: posixPath(pagesPathRelative),
+              permalink,
+              locale: i18n.currentLocale,
+            });
+          } else if (typeof editUrl === 'string') {
+            const isLocalized =
+              pagesDirPath === contentPaths.contentPathLocalized;
+            const fileContentPath =
+              isLocalized && options.editLocalizedFiles
+                ? contentPaths.contentPathLocalized
+                : contentPaths.contentPath;
+
+            const contentPathEditUrl = normalizeUrl([
+              editUrl,
+              posixPath(path.relative(siteDir, fileContentPath)),
+            ]);
+
+            return getEditUrl(pagesPathRelative, contentPathEditUrl);
+          }
+          return undefined;
+        }


Wonder if we could find a way to deduplicate/extract that complexity to utils? 🤔

website/docs/api/plugins/plugin-content-pages.mdx

website/docusaurus.config.ts

website/_dogfooding/dogfooding.config.ts

slorber · 2024-04-12T14:25:18Z

packages/docusaurus-plugin-content-pages/src/index.ts

+          editUrl: getItemEditUrl({
+            editUrl,
+            itemDirPath: pagesDirPath,
+            itemSourceAbsolute: pagesSourceAbsolute,
+            permalink,
+            i18n,
+            options,
+            siteDir,
+            contentPaths,
+          }),


😄 maybe that was a bad idea, if we can only use it on the pages plugin and not all other plugins it's probably not worth it to extract to docusaurus utils 😅 (didn't see at first that the edit URL fn all have different param names)

This reverts commit ebb35f6.

feat(pages): add support for last update date & author

426b8fc

facebook-github-bot added the CLA Signed Signed Facebook CLA label Apr 9, 2024

OzakIOne added 3 commits April 10, 2024 14:05

wip git last update not working

af80172

wip

0c058f0

wip

cd5223e

slorber added the pr: new feature This PR adds a new API or behavior. label Apr 11, 2024

OzakIOne and others added 4 commits April 11, 2024 16:49

Merge branch 'main' into ozaki/pages-lastupdate

279479e

refactor: apply lint autofix

5441315

feat: working

432efc4

cleanup

b18e6b4

OzakIOne marked this pull request as ready for review April 11, 2024 16:24

OzakIOne requested review from slorber and Josh-Cena as code owners April 11, 2024 16:24

OzakIOne added the Argos Add this label to run UI visual regression tests. See argos.yml GH action. label Apr 11, 2024

fix layout shift

b81ccfb

OzakIOne commented Apr 11, 2024

View reviewed changes

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

slorber requested changes Apr 11, 2024

View reviewed changes

OzakIOne added 5 commits April 11, 2024 19:34

wip

252d0f3

update link

ac155df

docs: add options

47c50e6

tests: update & add new test

4811749

wip fix css layout

e735aa1

slorber requested changes Apr 12, 2024

View reviewed changes

OzakIOne added 2 commits April 12, 2024 12:44

review

c39a898

wip extract getItemEditURL to utils

ebb35f6

slorber requested changes Apr 12, 2024

View reviewed changes

OzakIOne and others added 4 commits April 12, 2024 16:41

Revert "wip extract getItemEditURL to utils"

89b4cf7

This reverts commit ebb35f6.

update url

7e5f2c2

fix layout style

c31227d

mention feature will only work for markdown pages

287bf0b

OzakIOne changed the title ~~feat(pages): add support for last update date & author~~ feat(pages): add LastUpdateAuthor & LastUpdateTime & editUrl Apr 15, 2024

slorber merged commit d1590e3 into main Apr 16, 2024
31 of 32 checks passed

slorber deleted the ozaki/pages-lastupdate branch April 16, 2024 09:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(pages): add LastUpdateAuthor & LastUpdateTime & editUrl #10032

feat(pages): add LastUpdateAuthor & LastUpdateTime & editUrl #10032

OzakIOne commented Apr 9, 2024 •

edited

netlify bot commented Apr 9, 2024 •

edited

github-actions bot commented Apr 9, 2024 •

edited

github-actions bot commented Apr 9, 2024 •

edited

argos-ci bot commented Apr 11, 2024 •

edited

slorber left a comment

slorber left a comment

slorber Apr 12, 2024

slorber Apr 12, 2024

feat(pages): add LastUpdateAuthor & LastUpdateTime & editUrl #10032

feat(pages): add LastUpdateAuthor & LastUpdateTime & editUrl #10032

Conversation

OzakIOne commented Apr 9, 2024 • edited

Motivation

Test Plan

Test links

Related issues/PRs

netlify bot commented Apr 9, 2024 • edited

✅ [V2]

github-actions bot commented Apr 9, 2024 • edited

⚡️ Lighthouse report for the deploy preview of this PR

github-actions bot commented Apr 9, 2024 • edited

argos-ci bot commented Apr 11, 2024 • edited

slorber left a comment

Choose a reason for hiding this comment

slorber left a comment

Choose a reason for hiding this comment

slorber Apr 12, 2024

Choose a reason for hiding this comment

slorber Apr 12, 2024

Choose a reason for hiding this comment

OzakIOne commented Apr 9, 2024 •

edited

netlify bot commented Apr 9, 2024 •

edited

github-actions bot commented Apr 9, 2024 •

edited

github-actions bot commented Apr 9, 2024 •

edited

argos-ci bot commented Apr 11, 2024 •

edited