refactor: remove deprecated docs homePageId option (#6065)

facebook · Dec 7, 2021 · f96a051 · f96a051
1 parent c64987e
commit f96a051
Show file tree

Hide file tree

Showing 17 changed files with 94 additions and 173 deletions.
diff --git a/packages/docusaurus-migrate/src/__tests__/__fixtures__/expectedSiteConfig.js b/packages/docusaurus-migrate/src/__tests__/__fixtures__/expectedSiteConfig.js
@@ -37,7 +37,6 @@ module.exports = {
       '@docusaurus/preset-classic',
       {
         docs: {
-          homePageId: 'installation',
           showLastUpdateAuthor: true,
           showLastUpdateTime: true,
           editUrl: 'https://github.com/facebook/docusaurus/edit/main/docs/',
@@ -53,7 +52,7 @@ module.exports = {
       title: 'Docusaurus',
       logo: {src: 'img/docusaurus.svg'},
       items: [
-        {to: 'docs/', label: 'Docs', position: 'left'},
+        {to: 'docs/installation', label: 'Docs', position: 'left'},
         {to: 'docs/tutorial-setup', label: 'Tutorial', position: 'left'},
         {to: '/users', label: 'Users', position: 'left'},
         {

diff --git a/packages/docusaurus-migrate/src/index.ts b/packages/docusaurus-migrate/src/index.ts
@@ -226,9 +226,6 @@ export function createConfigFile({
   'v1Config' | 'siteDir' | 'newDir'
 >): VersionTwoConfig {
   const siteConfig = v1Config;
-  const homePageId = siteConfig.headerLinks?.filter((value) => value.doc)[0]
-    .doc;
-
   const customConfigFields: Record<string, unknown> = {};
   // add fields that are unknown to v2 to customConfigFields
   Object.keys(siteConfig).forEach((key) => {
@@ -309,7 +306,6 @@ export function createConfigFile({
         {
           docs: {
             ...(v2DocsPath && {path: v2DocsPath}),
-            homePageId,
             showLastUpdateAuthor: true,
             showLastUpdateTime: true,
             editUrl: siteConfig.editUrl,
@@ -334,7 +330,7 @@ export function createConfigFile({
             const position = 'left';
             if (doc) {
               return {
-                to: `docs/${doc === homePageId ? '' : doc}`,
+                to: `docs/${doc}`,
                 label,
                 position,
               };

diff --git a/...saurus-plugin-content-docs/src/__tests__/__fixtures__/simple-site/docs/hello.md b/...saurus-plugin-content-docs/src/__tests__/__fixtures__/simple-site/docs/hello.md
@@ -3,6 +3,7 @@ id: hello
 title: Hello, World !
 sidebar_label: Hello sidebar_label
 tags: [tag-1, tag 3]
+slug: /
 ---
 
 Hi, Endilie here :)

diff --git a/...gin-content-docs/src/__tests__/__fixtures__/site-with-doc-label/docs/hello-1.md b/...gin-content-docs/src/__tests__/__fixtures__/site-with-doc-label/docs/hello-1.md
@@ -1,6 +1,7 @@
 ---
 id: hello-1
 title: Hello 1
+slug: /
 ---
 
 Hello World 1!

diff --git a/...rus-plugin-content-docs/src/__tests__/__fixtures__/versioned-site/docs/hello.md b/...rus-plugin-content-docs/src/__tests__/__fixtures__/versioned-site/docs/hello.md
@@ -1 +1,4 @@
+---
+slug: /
+---
 Hello `next` !
diff --git a/...__/versioned-site/i18n/en/docusaurus-plugin-content-docs/version-1.0.0/hello.md b/...__/versioned-site/i18n/en/docusaurus-plugin-content-docs/version-1.0.0/hello.md
@@ -1 +1,4 @@
+---
+slug: /
+---
 Hello `1.0.0` ! (translated en)
diff --git a/...__/versioned-site/i18n/fr/docusaurus-plugin-content-docs/version-1.0.0/hello.md b/...__/versioned-site/i18n/fr/docusaurus-plugin-content-docs/version-1.0.0/hello.md
@@ -1 +1,4 @@
+---
+slug: /
+---
 Hello `1.0.0` ! (translated fr)
diff --git a/...src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.0/hello.md b/...src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.0/hello.md
@@ -1 +1,4 @@
+---
+slug: /
+---
 Hello `1.0.0` !
diff --git a/...src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.1/hello.md b/...src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.1/hello.md
@@ -1 +1,4 @@
+---
+slug: /
+---
 Hello `1.0.1` !
diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/docs.test.ts.snap b/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/docs.test.ts.snap
@@ -25,7 +25,7 @@ Array [
   Array [
     undefined,
     Object {
-      "permalink": "/docs/hello",
+      "permalink": "/docs/",
       "title": "Hello sidebar_label",
     },
   ],
@@ -41,7 +41,7 @@ Array [
   ],
   Array [
     Object {
-      "permalink": "/docs/hello",
+      "permalink": "/docs/",
       "title": "Hello sidebar_label",
     },
     Object {

diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/index.test.ts.snap b/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/index.test.ts.snap
@@ -314,7 +314,8 @@ Object {
     \\"tags\\": [
       \\"tag-1\\",
       \\"tag 3\\"
-    ]
+    ],
+    \\"slug\\": \\"/\\"
   },
   \\"sidebar\\": \\"docs\\",
   \\"previous\\": {
@@ -1528,7 +1529,9 @@ Object {
   \\"permalink\\": \\"/docs/next/\\",
   \\"tags\\": [],
   \\"version\\": \\"current\\",
-  \\"frontMatter\\": {},
+  \\"frontMatter\\": {
+    \\"slug\\": \\"/\\"
+  },
   \\"sidebar\\": \\"docs\\",
   \\"previous\\": {
     \\"title\\": \\"bar\\",
@@ -1606,7 +1609,9 @@ Object {
   \\"permalink\\": \\"/docs/1.0.0/\\",
   \\"tags\\": [],
   \\"version\\": \\"1.0.0\\",
-  \\"frontMatter\\": {},
+  \\"frontMatter\\": {
+    \\"slug\\": \\"/\\"
+  },
   \\"sidebar\\": \\"version-1.0.0/docs\\",
   \\"previous\\": {
     \\"title\\": \\"baz\\",
@@ -1684,7 +1689,9 @@ Object {
   \\"permalink\\": \\"/docs/\\",
   \\"tags\\": [],
   \\"version\\": \\"1.0.1\\",
-  \\"frontMatter\\": {},
+  \\"frontMatter\\": {
+    \\"slug\\": \\"/\\"
+  },
   \\"sidebar\\": \\"VersionedSideBarNameDoesNotMatter/docs\\",
   \\"previous\\": {
     \\"title\\": \\"bar\\",