From b3d906281b402753a6d6a160f8e1645a570bfc6e Mon Sep 17 00:00:00 2001 From: Ethan Rose <33912936+errose28@users.noreply.github.com> Date: Fri, 15 Dec 2023 10:04:27 -0800 Subject: [PATCH] HDDS-9578. Create skeleton for Ozone homepage (#52) --- docs/01-overview.md | 13 + docs/header-demo/_category_.json | 8 - docs/header-demo/demo.md | 7 - .../nested-header-demo/_category_.json | 8 - docs/header-demo/nested-header-demo/demo.md | 15 - docs/intro.md | 10 - docusaurus.config.js | 171 +++- src/components/HomepageFeatures/index.js | 43 - .../HomepageFeatures/styles.module.css | 11 - src/css/custom.css | 34 +- src/css/footer.css | 46 ++ src/css/header.css | 26 + src/pages/community/blogs.md | 5 + src/pages/community/communication-channels.md | 10 + src/pages/community/events-and-media.md | 6 + src/pages/community/how-to-contribute.md | 11 + src/pages/community/report-an-issue.md | 5 + src/pages/community/who-uses-ozone.md | 5 + src/pages/download.md | 14 + src/pages/faq.md | 9 + src/pages/index.js | 50 +- src/pages/index.module.css | 23 - src/pages/markdown-example.md | 11 - src/pages/release-notes/1.0.0.md | 4 + src/pages/release-notes/1.1.0.md | 4 + src/pages/release-notes/1.2.1.md | 4 + src/pages/release-notes/1.3.0.md | 4 + src/pages/roadmap.md | 5 + src/theme/DocSidebar/index.js | 19 + src/theme/DocSidebar/index.module.css | 34 + static/img/{ => favicon}/favicon.ico | Bin static/img/ozone-logo.svg | 737 +++++++++++++++++- 32 files changed, 1141 insertions(+), 211 deletions(-) create mode 100644 docs/01-overview.md delete mode 100644 docs/header-demo/_category_.json delete mode 100644 docs/header-demo/demo.md delete mode 100644 docs/header-demo/nested-header-demo/_category_.json delete mode 100644 docs/header-demo/nested-header-demo/demo.md delete mode 100644 docs/intro.md delete mode 100644 src/components/HomepageFeatures/index.js delete mode 100644 src/components/HomepageFeatures/styles.module.css create mode 100644 src/css/footer.css create mode 100644 src/css/header.css create mode 100644 src/pages/community/blogs.md create mode 100644 src/pages/community/communication-channels.md create mode 100644 src/pages/community/events-and-media.md create mode 100644 src/pages/community/how-to-contribute.md create mode 100644 src/pages/community/report-an-issue.md create mode 100644 src/pages/community/who-uses-ozone.md create mode 100644 src/pages/download.md create mode 100644 src/pages/faq.md delete mode 100644 src/pages/index.module.css delete mode 100644 src/pages/markdown-example.md create mode 100644 src/pages/release-notes/1.0.0.md create mode 100644 src/pages/release-notes/1.1.0.md create mode 100644 src/pages/release-notes/1.2.1.md create mode 100644 src/pages/release-notes/1.3.0.md create mode 100644 src/pages/roadmap.md create mode 100644 src/theme/DocSidebar/index.js create mode 100644 src/theme/DocSidebar/index.module.css rename static/img/{ => favicon}/favicon.ico (100%) diff --git a/docs/01-overview.md b/docs/01-overview.md new file mode 100644 index 000000000..a5c2be182 --- /dev/null +++ b/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 + diff --git a/docs/header-demo/_category_.json b/docs/header-demo/_category_.json deleted file mode 100644 index d26e8e072..000000000 --- a/docs/header-demo/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Example Summary", - "position": 2, - "link": { - "type": "generated-index", - "description": "The index page for sections under this header" - } -} diff --git a/docs/header-demo/demo.md b/docs/header-demo/demo.md deleted file mode 100644 index 6043cba0c..000000000 --- a/docs/header-demo/demo.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Example Nested Page - -This page is nested under a header. diff --git a/docs/header-demo/nested-header-demo/_category_.json b/docs/header-demo/nested-header-demo/_category_.json deleted file mode 100644 index 468cf02e6..000000000 --- a/docs/header-demo/nested-header-demo/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Nested Header", - "position": 2, - "link": { - "type": "generated-index", - "description": "The index page for sections under this nested header" - } -} diff --git a/docs/header-demo/nested-header-demo/demo.md b/docs/header-demo/nested-header-demo/demo.md deleted file mode 100644 index b95291c7a..000000000 --- a/docs/header-demo/nested-header-demo/demo.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Example Nested Page - -This page is nested under a header. - -## Section 1 - -- This section should show up in the mini-map automaticially. - -## Section 2 - -- This section should show up in the mini-map automaticially. diff --git a/docs/intro.md b/docs/intro.md deleted file mode 100644 index e1c7396e6..000000000 --- a/docs/intro.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Top Level Doc Page - -- Example page showing a top level documentation page not under any header. - -- The URL of any page by default is its path relative to the root. - - Use `slug` in the frontmatter to change this. diff --git a/docusaurus.config.js b/docusaurus.config.js index 994352167..a7bf85e85 100644 --- a/docusaurus.config.js +++ b/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 '//' 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:dev@ozone.apache.org' }, { - 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: ` +
+ Copyright © ${new Date().getFullYear()} The Apache Software Foundation. Licensed under the Apache License, Version 2.0.
+
+

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.

+
+
`, }, prism: { theme: lightCodeTheme, darkTheme: darkCodeTheme, }, + // TODO HDDS-9566 + algolia: { + appId: "PLACEHOLDER", + apiKey: "PLACEHOLDER", + indexName: "PLACEHOLDER", + searchParameters: {} + } }), scripts: ['/script/matomo.js'], }; diff --git a/src/components/HomepageFeatures/index.js b/src/components/HomepageFeatures/index.js deleted file mode 100644 index 378f4a945..000000000 --- a/src/components/HomepageFeatures/index.js +++ /dev/null @@ -1,43 +0,0 @@ -import React from 'react'; -import clsx from 'clsx'; -import styles from './styles.module.css'; - -const FeatureList = [ - { - title: 'Ozone', - Svg: require('@site/static/img/ozone-logo.svg').default, - description: ( - <> - Placeholder for Ozone homepage content - - ), - }, -]; - -function Feature({Svg, title, description}) { - return ( -
-
- -
-
-

{title}

-

{description}

-
-
- ); -} - -export default function HomepageFeatures() { - return ( -
-
-
- {FeatureList.map((props, idx) => ( - - ))} -
-
-
- ); -} diff --git a/src/components/HomepageFeatures/styles.module.css b/src/components/HomepageFeatures/styles.module.css deleted file mode 100644 index b248eb2e5..000000000 --- a/src/components/HomepageFeatures/styles.module.css +++ /dev/null @@ -1,11 +0,0 @@ -.features { - display: flex; - align-items: center; - padding: 2rem 0; - width: 100%; -} - -.featureSvg { - height: 200px; - width: 200px; -} diff --git a/src/css/custom.css b/src/css/custom.css index 2bc6a4cfd..6c5bee300 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -4,27 +4,23 @@ * work well for content-centric websites. */ -/* You can override the default Infima variables here. */ +/* Infima colors generated from --ifm-color-primary using https://docusaurus.io/docs/styling-layout#styling-your-site-with-infima */ :root { - --ifm-color-primary: #2e8555; - --ifm-color-primary-dark: #29784c; - --ifm-color-primary-darker: #277148; - --ifm-color-primary-darkest: #205d3b; - --ifm-color-primary-light: #33925d; - --ifm-color-primary-lighter: #359962; - --ifm-color-primary-lightest: #3cad6e; - --ifm-code-font-size: 95%; - --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1); + --ifm-color-primary: #357500; + --ifm-color-primary-dark: #306900; + --ifm-color-primary-darker: #2d6300; + --ifm-color-primary-darkest: #255200; + --ifm-color-primary-light: #3a8100; + --ifm-color-primary-lighter: #3d8700; + --ifm-color-primary-lightest: #459800; } -/* For readability concerns, you should choose a lighter palette in dark mode. */ [data-theme='dark'] { - --ifm-color-primary: #25c2a0; - --ifm-color-primary-dark: #21af90; - --ifm-color-primary-darker: #1fa588; - --ifm-color-primary-darkest: #1a8870; - --ifm-color-primary-light: #29d5b0; - --ifm-color-primary-lighter: #32d8b4; - --ifm-color-primary-lightest: #4fddbf; - --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); + --ifm-color-primary: #96d26e; + --ifm-color-primary-dark: #84ca56; + --ifm-color-primary-darker: #7bc749; + --ifm-color-primary-darkest: #64ab35; + --ifm-color-primary-light: #a8da86; + --ifm-color-primary-lighter: #b1dd93; + --ifm-color-primary-lightest: #cbe9b7; } diff --git a/src/css/footer.css b/src/css/footer.css new file mode 100644 index 000000000..af8748775 --- /dev/null +++ b/src/css/footer.css @@ -0,0 +1,46 @@ +/* Make footer dark regardless of the website theme */ +:root { + --footer-background-color: #202020; + --footer-foreground-color: #ccc; + --copyright-link-color: #96d26e +} + +html[data-theme='dark'] .footer { + background-color: var(--footer-background-color); +} + +html[data-theme='light'] .footer { + background-color: var(--footer-background-color); +} + +.footer__links { + color: var(--footer-foreground-color); +} + +.footer__link-item:hover { + color: var(--footer-foreground-color); +} + +.footer__link-item { + color: var(--footer-foreground-color); +} + +/* Remove Docusaurus icons next to links */ +footer.footer .footer__link-item svg { + display: none; +} + +footer.footer .footer__copyright { + color: #ccc; + font-size: 0.85rem; +} + +/* Keep copyright links in the footer the same color regardless of light or dark theme. */ +.copyright-link { + color: var(--copyright-link-color) +} + +.copyright-link:hover { + color: var(--copyright-link-color) +} + diff --git a/src/css/header.css b/src/css/header.css new file mode 100644 index 000000000..0c16f8c51 --- /dev/null +++ b/src/css/header.css @@ -0,0 +1,26 @@ +/* + * Style the header at the top of the site. + */ + +/* Style the GitHub logo */ +.header-github-link:hover { + opacity: 0.6; +} + +.header-github-link:before { + content: ''; + width: 24px; + height: 24px; + display: flex; + background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E") + no-repeat; +} + +html[data-theme='dark'] .header-github-link:before { + content: ''; + width: 24px; + height: 24px; + display: flex; + background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath fill='white' d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E") + no-repeat; +} diff --git a/src/pages/community/blogs.md b/src/pages/community/blogs.md new file mode 100644 index 000000000..968208e0a --- /dev/null +++ b/src/pages/community/blogs.md @@ -0,0 +1,5 @@ +# Blogs + +**TODO [HDDS-9619](https://issues.apache.org/jira/browse/HDDS-9619) Fill in this page.** + +Add links to blogs on Ozone published by various sources. diff --git a/src/pages/community/communication-channels.md b/src/pages/community/communication-channels.md new file mode 100644 index 000000000..2f9307b70 --- /dev/null +++ b/src/pages/community/communication-channels.md @@ -0,0 +1,10 @@ +# Communication Channels + +**TODO [HDDS-9618](https://issues.apache.org/jira/browse/HDDS-9618) Fill in this page.** + +Add links and sign up instructions for all the ways to get in contact with Ozone developers and users. This includes: +- Apache mailing lists +- Community Meetings +- Github Discussions +- Slack +- Jira diff --git a/src/pages/community/events-and-media.md b/src/pages/community/events-and-media.md new file mode 100644 index 000000000..714a78c5d --- /dev/null +++ b/src/pages/community/events-and-media.md @@ -0,0 +1,6 @@ +# Events and Media + +**TODO [HDDS-9620](https://issues.apache.org/jira/browse/HDDS-9620) Fill in this page.** + +- Document upcoming and past Ozone related events here. Include links to slides or recorded presentations given at these events. +- We can also link to the new [Ozone YouTube channel](https://www.youtube.com/@ApacheOzone) diff --git a/src/pages/community/how-to-contribute.md b/src/pages/community/how-to-contribute.md new file mode 100644 index 000000000..2c157928d --- /dev/null +++ b/src/pages/community/how-to-contribute.md @@ -0,0 +1,11 @@ +# How to Contribute + +**TODO [HDDS-9869](https://issues.apache.org/jira/browse/HDDS-9869) Fill in this page.** + +This may end up similar to CONTRIBUTING.md in the Ozone repo, but should document all the ways to contribute outside of code as well. +- Testing and filing issues + - This may link to the [Report an Issue](report-an-issue) page. +- Contributing code + - Both Ozone backend and Recon UI/UX front end. +- Contributing to the website +- Graphic design work for logos or diagrams. diff --git a/src/pages/community/report-an-issue.md b/src/pages/community/report-an-issue.md new file mode 100644 index 000000000..542c9220a --- /dev/null +++ b/src/pages/community/report-an-issue.md @@ -0,0 +1,5 @@ +# Report an Issue + +**TODO [HDDS-9870](https://issues.apache.org/jira/browse/HDDS-9870) Fill in this page.** + +This can link to other relevant sections as necessary, like Jira account signup in [Communication Channels](communication-channels). It should include best practices for filing detailed Jira descriptions, titles, and adding labels or other fields. diff --git a/src/pages/community/who-uses-ozone.md b/src/pages/community/who-uses-ozone.md new file mode 100644 index 000000000..3b3c974c0 --- /dev/null +++ b/src/pages/community/who-uses-ozone.md @@ -0,0 +1,5 @@ +# Who Uses Ozone? + +**TODO [HDDS-9621](https://issues.apache.org/jira/browse/HDDS-9621) Fill in this page.** + +Port this page over from Confluence. Add more details about the use case if available. Add instructions to include your organization on this page if you are using Ozone. diff --git a/src/pages/download.md b/src/pages/download.md new file mode 100644 index 000000000..93c7dac36 --- /dev/null +++ b/src/pages/download.md @@ -0,0 +1,14 @@ +# Downloads + +**TODO [HDDS-9616](https://issues.apache.org/jira/browse/HDDS-9616) Fill in this page.** + +Fill this in similar to what is on the current website. +- Create in a table with all release information from 1.0.0-1.3.0 (example below). +- Include instructions for verifying signatures and checksums. +- Include license information. +- Fill in the release notes pages for all past versions 1.0.0-1.3.0. + +| Version | Release Date | Source Download | Binary Download | Release Notes | +|-|-|-|-|-| +| 1.3.0 | 2022 Dec 18 | [Source](https://www.apache.org/dyn/closer.cgi/ozone/1.3.0/ozone-1.3.0-src.tar.gz)
[Checksum](https://downloads.apache.org/ozone/1.3.0/ozone-1.3.0-src.tar.gz.sha512)
[Signature](https://downloads.apache.org/ozone/1.3.0/ozone-1.3.0-src.tar.gz.asc) | [Binary](https://www.apache.org/dyn/closer.cgi/ozone/1.3.0/ozone-1.3.0.tar.gz)
[Checksum](https://downloads.apache.org/ozone/1.3.0/ozone-1.3.0.tar.gz.sha512)
[Signature](https://downloads.apache.org/ozone/1.3.0/ozone-1.3.0.tar.gz.asc) | [Release Notes](/release-notes/1.3.0) | + diff --git a/src/pages/faq.md b/src/pages/faq.md new file mode 100644 index 000000000..ef29a55e9 --- /dev/null +++ b/src/pages/faq.md @@ -0,0 +1,9 @@ +# FAQ + +**TODO [HDDS-9863](https://issues.apache.org/jira/browse/HDDS-9863) Fill in this page.** + +Fill this in with each question as a level 2 header. Include link to Github discussions from this page for asking new questions and proposing additions to this page. + +## What is Ozone? + +Someone answer this question. diff --git a/src/pages/index.js b/src/pages/index.js index 58695be63..83fd295c8 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -1,33 +1,39 @@ import React from 'react'; -import clsx from 'clsx'; import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; import Layout from '@theme/Layout'; -import HomepageFeatures from '@site/src/components/HomepageFeatures'; - -import styles from './index.module.css'; - -function HomepageHeader() { - const {siteConfig} = useDocusaurusContext(); - return ( -
-
-

{siteConfig.title}

-

{siteConfig.tagline}

-
-
- ); -} +import Logo from '@site/static/img/ozone-logo.svg'; export default function Home() { const {siteConfig} = useDocusaurusContext(); + const getStartedHref = `docs/quick-start/installation/docker` return ( - -
- -
+ title={`Welcome to ${siteConfig.title}`} + description="{siteConfig.tagline}"> +
+
+
+
+

{siteConfig.title}

+

+ {siteConfig.tagline} +
+ TODO HDDS-9539 +

+ +
+
+ +
+
+
+
); } diff --git a/src/pages/index.module.css b/src/pages/index.module.css deleted file mode 100644 index 9f71a5da7..000000000 --- a/src/pages/index.module.css +++ /dev/null @@ -1,23 +0,0 @@ -/** - * CSS files with the .module.css suffix will be treated as CSS modules - * and scoped locally. - */ - -.heroBanner { - padding: 4rem 0; - text-align: center; - position: relative; - overflow: hidden; -} - -@media screen and (max-width: 996px) { - .heroBanner { - padding: 2rem; - } -} - -.buttons { - display: flex; - align-items: center; - justify-content: center; -} diff --git a/src/pages/markdown-example.md b/src/pages/markdown-example.md deleted file mode 100644 index 9cca07773..000000000 --- a/src/pages/markdown-example.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Example Markdown Page -description: An example markdown page -hide_table_of_contents: true ---- - -# Markdown page example - -- Example of a plain markdown page created outside of the docs section. - -- Viewable at `/` diff --git a/src/pages/release-notes/1.0.0.md b/src/pages/release-notes/1.0.0.md new file mode 100644 index 000000000..faf92bbba --- /dev/null +++ b/src/pages/release-notes/1.0.0.md @@ -0,0 +1,4 @@ +# Apache Ozone 1.0.0 Release Notes + +**TODO [HDDS-9617](https://issues.apache.org/jira/browse/HDDS-9617) Fill in this page.** + diff --git a/src/pages/release-notes/1.1.0.md b/src/pages/release-notes/1.1.0.md new file mode 100644 index 000000000..799650ba6 --- /dev/null +++ b/src/pages/release-notes/1.1.0.md @@ -0,0 +1,4 @@ +# Apache Ozone 1.1.0 Release Notes + +**TODO [HDDS-9617](https://issues.apache.org/jira/browse/HDDS-9617) Fill in this page.** + diff --git a/src/pages/release-notes/1.2.1.md b/src/pages/release-notes/1.2.1.md new file mode 100644 index 000000000..acdeac1ac --- /dev/null +++ b/src/pages/release-notes/1.2.1.md @@ -0,0 +1,4 @@ +# Apache Ozone 1.2.1 Release Notes + +**TODO [HDDS-9617](https://issues.apache.org/jira/browse/HDDS-9617) Fill in this page.** + diff --git a/src/pages/release-notes/1.3.0.md b/src/pages/release-notes/1.3.0.md new file mode 100644 index 000000000..33bc53803 --- /dev/null +++ b/src/pages/release-notes/1.3.0.md @@ -0,0 +1,4 @@ +# Apache Ozone 1.3.0 Release Notes + +**TODO [HDDS-9617](https://issues.apache.org/jira/browse/HDDS-9617) Fill in this page.** + diff --git a/src/pages/roadmap.md b/src/pages/roadmap.md new file mode 100644 index 000000000..71f8c162d --- /dev/null +++ b/src/pages/roadmap.md @@ -0,0 +1,5 @@ +# Roadmap + +**TODO [HDDS-9615](https://issues.apache.org/jira/browse/HDDS-9615) Fill in this page.** + +Port the Ozone roadmap over from Confluence. The release guide should state to update this page with each release. diff --git a/src/theme/DocSidebar/index.js b/src/theme/DocSidebar/index.js new file mode 100644 index 000000000..f4df5f584 --- /dev/null +++ b/src/theme/DocSidebar/index.js @@ -0,0 +1,19 @@ +import React from 'react'; +import DocSidebar from '@theme-original/DocSidebar'; +import DocsVersionDropdownNavbarItem from '@theme-original/NavbarItem/DocsVersionDropdownNavbarItem'; +import styles from './index.module.css'; + +export default function DocSidebarWrapper(props) { + return ( + <> +
+
+
Version:
+
+
+ +
+
+ + ); +} diff --git a/src/theme/DocSidebar/index.module.css b/src/theme/DocSidebar/index.module.css new file mode 100644 index 000000000..5194f67fe --- /dev/null +++ b/src/theme/DocSidebar/index.module.css @@ -0,0 +1,34 @@ +/* + * Add a version dropdown to the docs sidebar. + */ + +.scrollCustom { + height: 100%; + overflow-y: auto; + overflow-x: hidden; + margin-top: var(--ifm-navbar-height); +} + +#sidebarCssSelector > div { + padding-top: 0 !important; +} + +aside .customSidebarVersion { + padding: 0.5rem 0 0 0.5rem; +} + +aside .customSidebarInner { + align-items: center; + border: 1px solid #eee; + border-radius: 0.5rem; + box-shadow: 0 1px 2px 0 rgba(0,0,0,.03); + display: flex; + margin: 1rem; + padding: 4px 1rem; +} + +aside .customSidebarVersion p { + margin-bottom: 0; + font-size: var(--fbc-font-size: 13px;); + padding: var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal); +} diff --git a/static/img/favicon.ico b/static/img/favicon/favicon.ico similarity index 100% rename from static/img/favicon.ico rename to static/img/favicon/favicon.ico diff --git a/static/img/ozone-logo.svg b/static/img/ozone-logo.svg index 7a8b5dd90..180f8032f 100644 --- a/static/img/ozone-logo.svg +++ b/static/img/ozone-logo.svg @@ -1,9 +1,728 @@ - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +