HDDS-9578. Create skeleton for Ozone homepage (#52)

docs/01-overview.md

@@ -0,0 +1,13 @@
+---
+# Make this the default docs landing page.
+slug: /
+---
+
+# Overview
+
+**TODO:** [HDDS-9864](https://issues.apache.org/jira/browse/HDDS-9864) and complete this page
+
+## What is Ozone?
+
+## Features
+

docusaurus.config.js

@@ -8,7 +8,7 @@ const darkCodeTheme = themes.dracula;
 /** @type {import('@docusaurus/types').Config} */
 const config = {
   title: 'Apache Ozone',
-  tagline: 'Scalable, redundant, and distributed object store',
+  tagline: 'Scalable, redundant, distributed storage system optimized for data analytics and object store workloads',
   favicon: 'img/favicon.ico',
 
   // Set the production url of your site here
@@ -17,8 +17,11 @@ const config = {
   // For GitHub pages deployment, it is often '/<projectName>/'
   baseUrl: '/',
 
+  // Fail the build if there are any broken links.
   onBrokenLinks: 'throw',
-  onBrokenMarkdownLinks: 'warn',
+  onBrokenMarkdownLinks: 'throw',
+  // Fail the build if multiple pages map to the same URL.
+  onDuplicateRoutes: 'throw',
 
   // Even if you don't use internalization, you can use this field to set useful
   // metadata like html lang. For example, if your site is Chinese, you may want
@@ -40,7 +43,11 @@ const config = {
             'https://github.com/apache/ozone-site/tree/HDDS-9225-website-v2',
         },
         theme: {
-          customCss: require.resolve('./src/css/custom.css'),
+          customCss: [
+            require.resolve('./src/css/custom.css'),
+            require.resolve('./src/css/header.css'),
+            require.resolve('./src/css/footer.css'),
+          ],
         },
       }),
     ],
@@ -49,8 +56,20 @@ const config = {
   themeConfig:
     /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
     ({
+      colorMode: {
+        defaultMode: 'light'
+      },
+      // Optional: Add an announcement bar to the top of the website.
+      // announcementBar: {
+      //   id: 'announce',
+      //   backgroundColor: 'var(--color-accent)',
+      //   textColor: 'white',
+      //   content:
+      //       'Sample Announcement Content',
+      // },
+
       // TODO Generate social card for Ozone.
-      // image: 'img/docusaurus-social-card.jpg',
+      // image: 'img/ozone-social-card.png',
       navbar: {
         title: 'Apache Ozone',
         logo: {
@@ -59,66 +78,168 @@ const config = {
         },
         items: [
           {
-            type: 'docSidebar',
-            sidebarId: 'tutorialSidebar',
-            position: 'left',
             label: 'Docs',
+            to: 'docs',
+            position: 'left',
+          },
+          {
+            to: 'download',
+            label: 'Download',
+          },
+          {
+            to: 'roadmap',
+            label: 'Roadmap',
+          },
+          {
+            to: 'faq',
+            label: 'FAQ',
+          },
+          {
+            label: 'Community',
+            items: [
+              {
+                to: 'community/communication-channels',
+                label: 'Communication Channels',
+              },
+              {
+                to: 'community/who-uses-ozone',
+                label: 'Who Uses Ozone?',
+              },
+              {
+                to: 'community/report-an-issue',
+                label: 'Report An Issue',
+              },
+              {
+                to: 'community/how-to-contribute',
+                label: 'How to Contribute',
+              },
+              {
+                to: 'community/events-and-media',
+                label: 'Events and Media',
+              },
+              {
+                to: 'community/blogs',
+                label: 'Blogs',
+              },
+            ]
+          },
+          {
+            type: 'localeDropdown',
+            position: 'right',
           },
           {
             href: 'https://github.com/apache/ozone',
-            label: 'GitHub',
             position: 'right',
+            className: 'header-github-link',
+            'aria-label': 'GitHub Repo',
           },
         ],
       },
       footer: {
-        // TODO style the footer. Leaving the stock docusaurus one as a reference.
-        /*
-        style: 'dark',
         links: [
           {
-            title: 'Docs',
+            title: 'Apache Software Foundation',
             items: [
               {
-                label: 'Tutorial',
-                to: '/docs/intro',
+                label: 'Foundation',
+                href: 'https://www.apache.org/'
               },
-            ],
+              {
+                label: 'License',
+                href: 'https://www.apache.org/licenses/'
+              },
+              {
+                label: 'Events',
+                href: 'https://www.apache.org/events/current-event'
+              },
+              {
+                label: 'Sponsorship',
+                href: 'https://www.apache.org/foundation/sponsorship.html'
+              },
+              {
+                label: 'Privacy',
+                href: 'https://privacy.apache.org/policies/privacy-policy-public.html'
+              },
+              {
+                label: 'Security',
+                href: 'https://www.apache.org/security/'
+              },
+              {
+                label: 'Thanks',
+                href: 'https://www.apache.org/foundation/thanks.html'
+              },
+            ]
           },
           {
             title: 'Community',
             items: [
               {
-                label: 'Stack Overflow',
-                href: 'https://stackoverflow.com/questions/tagged/docusaurus',
+                label: 'GitHub Discussions',
+                href: 'https://github.com/apache/ozone/discussions'
+              },
+              {
+                label: 'Jira Issues',
+                href: 'https://issues.apache.org/jira/projects/HDDS/issues'
+              },
+              {
+                label: 'Slack',
+                href: 'https://infra.apache.org/slack.html'
+              },
+              {
+                label: 'Mailing List',
+                href: 'mailto:[email protected]'
               },
               {
-                label: 'Discord',
-                href: 'https://discordapp.com/invite/docusaurus',
+                label: 'YouTube',
+                href: 'https://www.youtube.com/@ApacheOzone'
               },
               {
                 label: 'Twitter',
-                href: 'https://twitter.com/docusaurus',
+                href: 'https://twitter.com/ApacheOzone'
               },
             ],
           },
           {
-            title: 'More',
+            title: 'Repositories',
             items: [
               {
-                label: 'GitHub',
-                href: 'https://github.com/facebook/docusaurus',
+                label: 'Ozone',
+                to: 'https://github.com/apache/ozone',
+              },
+              {
+                label: 'Website',
+                to: 'https://github.com/apache/ozone-site',
+              },
+              {
+                label: 'Docker Image',
+                to: 'https://github.com/apache/ozone-docker',
+              },
+              {
+                label: 'Docker Runner Image',
+                to: 'https://github.com/apache/ozone-docker-runner',
               },
             ],
           },
         ],
-        copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
-      */
+        copyright: `
+        <div>
+          Copyright © ${new Date().getFullYear()} <a href="https://www.apache.org/" class=copyright-link>The Apache Software Foundation</a>. Licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0" class=copyright-link>Apache License, Version 2.0</a>. <br>
+          <div>
+            <p>The Apache Software Foundation, Apache Ozone, Ozone, Apache, the Apache Feather, and the Apache Ozone project logo are either registered trademarks or trademarks of the Apache Software Foundation.</p>
+          </div>
+        </div>`,
       },
       prism: {
         theme: lightCodeTheme,
         darkTheme: darkCodeTheme,
       },
+      // TODO HDDS-9566
+      algolia: {
+        appId: "PLACEHOLDER",
+        apiKey: "PLACEHOLDER",
+        indexName: "PLACEHOLDER",
+        searchParameters: {}
+      }
     }),
     scripts: ['/script/matomo.js'],
 };