Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add script to copy homepage into website dir #3295

Merged

Conversation

radium-v
Copy link
Collaborator

Description

Adds a pre-build step for the Docusaurus build that builds and copies the homepage code as a static page.

Motivation & context

Since the new homepage isn't written to fit directly into Docusaurus, this method keeps the codebases separated. Ideally, this script will be moved or replaced with a more robust solution in the near future.

Issue type checklist

  • Chore: A change that does not impact distributed packages.
  • Bug fix: A change that fixes an issue, link to the issue above.
  • New feature: A change that adds functionality.

Is this a breaking change?

  • This change causes current functionality to break.

Adding or modifying component(s) in @microsoft/fast-components checklist

Process & policy checklist

  • I have added tests for my changes.
  • I have tested my changes.
  • I have updated the project documentation to reflect my changes.
  • I have read the CONTRIBUTING documentation and followed the standards for this project.

@radium-v radium-v force-pushed the users/jokreitl/site-docusaurus-shoehorn branch from 9532b9a to 7871116 Compare June 12, 2020 20:52
@radium-v radium-v self-assigned this Jun 12, 2020
@radium-v radium-v force-pushed the users/jokreitl/site-docusaurus-shoehorn branch from 7871116 to d58bc21 Compare June 12, 2020 20:54
],
},
plugins: [
new CleanWebpackPlugin(),
new HtmlWebpackPlugin({
title: "FAST website",
title: "FAST",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you inform more in the title for SEO? "FAST - An adaptive UI design system" for example on the home page or whatever our tagline may be?

@@ -13,12 +13,19 @@ module.exports = {
async: true,
},
],
themes: ["@docusaurus/theme-live-codeblock"],
themes: [require.resolve("@docusaurus/theme-live-codeblock")],
themeConfig: {
navbar: {
logo: {
alt: "FAST-DNA",
src: "img/logo.svg",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good candidate for the CDN https://static.fast.design/assets/brand/fast-logo.svg as an example and is achievable by placing in /sites/site-utilities/statics/assets/brand/fast-logo.svg upon merge to master ( know this is a feature branch ) it would deploy to CDN.

Copy link
Contributor

@EisenbergEffect EisenbergEffect left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one minor recommendation on links, otherwise looks good. Doesn't have to be perfect for our needs, just get the job done 😄 Thanks for working on this...I know it wasn't the most fun task in the world.

@@ -23,7 +23,7 @@
<ul>
<li><fast-anchor appearance="lightweight" href="https://explore.fast.design">Components</fast-anchor></li>
<li><fast-anchor appearance="lightweight" href="#">Integration</fast-anchor></li>
<li><fast-anchor appearance="lightweight" href="https://www.fast.design/docs/en/contributing/install">Documentation</fast-anchor></li>
<li><fast-anchor appearance="lightweight" href="/docs/fast-foundation/getting-started">Documentation</fast-anchor></li>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should probably go to /docs/introduction

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch Rob. We'll want everything to be relative so that when they the same files move through the Front Door into staging environment or production the entire site is functional.

@@ -45,7 +45,7 @@
<fast-badge slot="badge" class="section-badge">ADAPTIVE UI SYSTEM, UTILITIES, & TOOLS</fast-badge>
<h1 class="section-heading-hero">The adaptive interface system for modern web experiences</h1>
<p slot="body">Interfaces bult with FAST adapt to your design system and can be used with any modern UI Framework by leveraging industry standard Web Components.</p>
<fast-button slot="action" appearance="accent">Get started</fast-button>
<fast-button slot="action" appearance="accent" href="/docs/fast-foundation/getting-started">Get started</fast-button>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this one makes sense to have direct to the getting started, but the one above should probably go to the docs intro. Thoughts?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll have another PR to cover the rest of the page's links.

@radium-v radium-v force-pushed the users/jokreitl/site-docusaurus-shoehorn branch from ba151f1 to 534aceb Compare June 12, 2020 23:37
@radium-v radium-v merged commit 8cc1b01 into feature/fast-frame Jun 15, 2020
@radium-v radium-v deleted the users/jokreitl/site-docusaurus-shoehorn branch June 15, 2020 19:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants