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

Update to Docusaurus 2.0 #2927

Merged
merged 3 commits into from Jul 6, 2021
Merged

Update to Docusaurus 2.0 #2927

merged 3 commits into from Jul 6, 2021

Conversation

ckipp01
Copy link
Member

@ckipp01 ckipp01 commented Jul 3, 2021

So there are a bunch of changes here and I still need to update a last few things.

  • Clean up dead links (NOTE: That when clicking around on the example site I had to get rid of the /metals/ root in order for it to deploy right on Vercel, so if you randomly click on something that is hardcoded to metals/docs for example it will 404 just because on my published version it's just docs/. I've been able to locally though confirm that all the links are valid. It warns you now when you build if there are any.)
  • Make sure full blog is there on build

Just to give a brief overview, taken from the Docusaurus website:

Docusaurus v2 is beta but already quite stable and widely used.

We highly encourage you to use Docusaurus v2 over Docusaurus v1, as Docusaurus v1 will be deprecated soon.

A lot of users are already using Docusaurus v2 (trends).

Use Docusaurus v2 if:

✅ You want a modern Jamstack documentation site
✅ You want a single-page application (SPA) with client-side routing
✅ You want the full power of React and MDX
✅ You do not need support for IE11
Use Docusaurus v1 if:

❌ You don't want a single-page application (SPA)
❌ You need support for IE11

I also did this migration partially with their migration-helper, but there ended up being a pretty large chunk that needed to be done manually.

I published a temp version of the site at https://metals-test-ckipp01.vercel.app/ so feel free to poke around and let me know what you think.

@ckipp01 ckipp01 marked this pull request as ready for review July 4, 2021 09:50
Copy link
Contributor

@tgodzik tgodzik left a comment

Choose a reason for hiding this comment

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

Thanks for working on this! Looks pretty neat. I have some doubts about:

image

O we able to modify it to some other picture or just text? It's kind of weird to have these emoticons there.

docs/editors/overview.md Outdated Show resolved Hide resolved
docs/editors/vscode.md Outdated Show resolved Hide resolved
Copy link
Member Author

@ckipp01 ckipp01 left a comment

Choose a reason for hiding this comment

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

Thanks for working on this! Looks pretty neat. I have some doubts about:
O we able to modify it to some other picture or just text? It's kind of weird to have these emoticons there.

So by default that's what they use. I think it's pretty standard as well since when you look around for examples of light/dark mode switches you often see them with a sun and moon icon to notify the user which they are on. Is there something specific about them that you don't like or that worries you?

EDIT:

It looks like you can switch the icons, but I'm unsure what we'd switch them to. https://docusaurus.io/docs/api/themes/configuration#color-mode---dark-mode

docs/editors/overview.md Outdated Show resolved Hide resolved
docs/editors/vscode.md Outdated Show resolved Hide resolved
@tgodzik
Copy link
Contributor

tgodzik commented Jul 5, 2021

So by default that's what they use. I think it's pretty standard as well since when you look around for examples of light/dark mode switches you often see them with a sun and moon icon to notify the user which they are on. Is there something specific about them that you don't like or that worries you?

That's I guess personal preference, it kind of looks like an old communicator icon, so I might be biased because of that. It's just weird to see emoticons, where they are not needed. Even plain sun/moon would be much better.

image

This is the polish communicator I am always thinking about with this.

@ckipp01
Copy link
Member Author

ckipp01 commented Jul 5, 2021

Even plain sun/moon would be much better.

Let me see if I can find two plain icons.

@ckipp01
Copy link
Member Author

ckipp01 commented Jul 5, 2021

What do you think of this?

2021-07-05 14 11 24

@tgodzik
Copy link
Contributor

tgodzik commented Jul 5, 2021

Looks good!

Copy link
Contributor

@tgodzik tgodzik left a comment

Choose a reason for hiding this comment

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

LGTM from my side! Tested it locall and everything seems to work.

@ckipp01
Copy link
Member Author

ckipp01 commented Jul 5, 2021

LGTM from my side! Tested it locall and everything seems to work.

Cool, I'll wait for another day to see if the others have any input, if now I'll merge away!

@ckipp01 ckipp01 merged commit 24479e4 into scalameta:main Jul 6, 2021
@ckipp01 ckipp01 deleted the website branch July 6, 2021 07:14
@ckipp01
Copy link
Member Author

ckipp01 commented Jul 6, 2021

Publish failed. Looks like a command isn't found, digging into it now.

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.

None yet

2 participants