Skip to content

Refactor the site to use Docusaurus #9

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Refactor the site to use Docusaurus #9

wants to merge 5 commits into from

Conversation

glarizza
Copy link

PROBLEM:

The existing site is using out of date versions of Docsy and Hugo. We need to either upgrade those components, or use the time to switch to a different static site generator.

SOLUTION:

Use Docusaurus. Jeff has had a good experience using it with Holos, so let's use the opportunity to switch the site to Docusaurus.

This commit refactors the existing site content to use Docusaurus with the following details:

  • Removed the Logo blog as it really doesn't serve us well.
  • Used undraw.co SVG graphics on the landing page.
  • Removed "Google Partners" because evidently we aren't anymore.
  • Setup redirects to the existing site URLs so Google won't complain.

OUTCOME:

Our existing site content, but on a different static site generation platform, and one that is easy for us to update.

@cloudflare-workers-and-pages Cloudflare Workers and Pages
Copy link

cloudflare-workers-and-pages bot commented Jul 12, 2024 •
edited
Loading

Deploying openinfrastructure-github-io with  Cloudflare Pages  Cloudflare Pages

Latest commit: 9489b7a
Status: ✅  Deploy successful!
Preview URL: https://79ca467b.openinfrastructure-github-io.pages.dev

View logs

glarizza added 2 commits July 12, 2024 10:40
@glarizza
Remove everything
5ca00c2
@glarizza
Refactor the site to use Docusaurus
6d48d71 
PROBLEM:

The existing site is using out of date versions of Docsy and Hugo. We
need to either upgrade those components, or use the time to switch to
a different static site generator.

SOLUTION:

Use Docusaurus. Jeff has had a good experience using it with Holos, so
let's use the opportunity to switch the site to Docusaurus.

This commit refactors the existing site content to use Docusaurus with
the following details:

Removed the Logo blog as it really doesn't serve us well.
Used undraw.co SVG graphics on the landing page.
Removed "Google Partners" because evidently we aren't anymore.
Setup redirects to the existing site URLs so Google won't complain.
OUTCOME:

Our existing site content, but on a different static site generation
platform, and one that is easy for us to update.
@glarizza
Update package.json and package-lock.json
aef9fb9 
I updated the temporary package name to the name of our repo.
@glarizza glarizza mentioned this pull request Jul 12, 2024
Closed
@glarizza
Copy link
Author

NOTE: Before we merge this we would need to:

  • Setup the openinfrastructure.co DNS mapping in Cloudflare + Cloudflare Pages
  • Ensure that updates to the main branch trigger a deploy of the site that's ultimately mapped to openinfrastructure.co

Right now I've been using https://openinfrastructure-github-io.pages.dev/ which is mapped to the docusaurus_site branch of this repo. That would need to be disabled completely, or updated to achieve what we want in the previous bullets.

natemccurdy
natemccurdy reviewed Jul 12, 2024
View reviewed changes
Copy link
Contributor

@natemccurdy natemccurdy left a comment

Choose a reason for hiding this comment

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

I think we want to commit yarn.lock as part of this. Doing so should help to prevent the "everything broke when we built the site a year from now" problem that we hit with Hugo. Right?

@glarizza
Copy link
Author

glarizza commented Jul 12, 2024 •
edited
Loading

I think we want to commit yarn.lock as part of this. Doing so should help to prevent the "everything broke when we built the site a year from now" problem that we hit with Hugo. Right?

We're using npm build to build and deploy the site, which I believe uses package.json and package-lock.json. I believe one COULD use yarn, but I've yet to run it. (only npm run start and npm run build from
https://docusaurus.io/docs/installation#running-the-development-server) I'm realizing now that the canned README file ONLY references yarn, so lemme update that.

glarizza added 2 commits July 12, 2024 14:19
@glarizza
Update README
45e6faf 
The previous README was the canned version using `yarn` to install,
build, and deploy the site. We're using `npm` to build and deploy the
site with Cloudflare, so I've updated the README to include the
`npm`-specific instructions.
@glarizza
Don't truncate generated card text
9489b7a 
PROBLEM:

On the autogenerated index pages (/services and /technical), the
descriptions of the pages represented by the cards were being truncated.

SOLUTION:

Update the CSS to disable truncation.

OUTCOME:

Full descriptions are available on the autogenerated index pages for
each referenced child pageD.
natemccurdy
natemccurdy approved these changes Jul 19, 2024
View reviewed changes
Copy link
Contributor

@natemccurdy natemccurdy left a comment

Choose a reason for hiding this comment

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

Looks good to me, and everything works on the preview site: https://79ca467b.openinfrastructure-github-io.pages.dev/

🚢 it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@natemccurdy natemccurdy natemccurdy approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@glarizza @natemccurdy