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

Docusaurus upgrade debugging #133

Merged
merged 4 commits into from Apr 7, 2021
Merged

Docusaurus upgrade debugging #133

merged 4 commits into from Apr 7, 2021

Conversation

ghost
Copy link

@ghost ghost commented Jan 24, 2021

  1. docusaurus-plugin-sass"from 0.1.08 to 0.1.11
  2. config modification
  3. Implement Navbar/index.js accordingly

1. docusaurus-plugin-sass"from  ^0.1.08 to 0.1.11
2. config modification
3. Implement Navbar/index.js accordingly
Copy link
Member

@phated phated left a comment

Choose a reason for hiding this comment

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

I reviewed the site and found a bunch of issues that need to be fixed. I will comment on the PR thread.

disableDarkMode: true,
colorMode: {
defaultMode: 'light',
disableSwitch: false,
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
disableSwitch: false,
disableSwitch: true,

This should be true, as our theme doesn't work with dark mode.

@phated
Copy link
Member

phated commented Jan 27, 2021

The algolia search box changed and needs styling updates to match our search box:

The changes make it look like this:
Screen Shot 2021-01-27 at 12 40 21 PM

But it should look like this:
Screen Shot 2021-01-27 at 12 43 09 PM

And on mobile:
Screen Shot 2021-01-27 at 12 49 12 PM

But should look like:
Screen Shot 2021-01-27 at 12 46 53 PM

I'm okay adjusting to to a dark-background search icon for mobile, but it would need to come with additional navbar updates to make things look proportionate.

@phated
Copy link
Member

phated commented Jan 27, 2021

The word "logo" appears in the footer for some reason now:

Screen Shot 2021-01-27 at 12 46 09 PM

@phated
Copy link
Member

phated commented Jan 27, 2021

The plugins page keyword lists got messed up:
Screen Shot 2021-01-27 at 12 45 41 PM
Screen Shot 2021-01-27 at 12 45 47 PM

I assume this was a change with the underlying css library that we use from docusaurus

@phated
Copy link
Member

phated commented Jan 27, 2021

We should also remove this patch #130 that was put into place to fix an issue until we upgraded past alpha.66

@phated
Copy link
Member

phated commented Jan 27, 2021

@donghwipark let me know once you've completed those fixes and I will review again.

@ghost
Copy link
Author

ghost commented Feb 23, 2021

@phated I fixed the issues you mentioned above. Please confirm.

Copy link
Member

@phated phated left a comment

Choose a reason for hiding this comment

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

@donghwipark great work on this! I have some cleanup that I'm going to push then I'll merge!

src/css/docs.css Outdated
Comment on lines 170 to 192
.navbar .navbar__search .navbar__search-input {
width: 15.5rem;
.DocSearch.DocSearch-Button {
width: 12.5rem;
height: 2.25rem;
font-size: 1rem;
border-radius: 0;
color: #ffffff;
background-color: #9a2829;
font-family: var(--ifm-font-family-base);
border-radius: var(--ifm-global-radius);
}
.DocSearch.DocSearch-Button:hover {
background-color: #9a2829;
color: #ffffff;
height: 2.25rem;
}
.navbar__items .DocSearch-Button .DocSearch-Search-Icon {
width: 1rem;
height: 1rem;
color: #ffffff;
}
Copy link
Member

Choose a reason for hiding this comment

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

There's a bunch of issues here, but I'm just going to push a fix.

Copy link
Member

Choose a reason for hiding this comment

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

Specifically, you should have been using the css variables and reviewing the different states, hover/active/etc.

src/css/docs.css Outdated
Comment on lines 213 to 225
.DocSearch.DocSearch-Button {
width: 100%;
margin: 0;
height: 2.25rem;
font-size: 1rem;
border-radius: 0;
color: #ffffff;
background-color: #9a2829;
font-family: var(--ifm-font-family-base);
}
span.DocSearch-Button-Placeholder {
display: block;
}
Copy link
Member

Choose a reason for hiding this comment

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

Same as above. Also, you added code instead of replacing the navbar__search stuff,

src/css/docs.css Outdated
Comment on lines 336 to 338
button.copyButton_node_modules-\@docusaurus-theme-classic-src-theme-CodeBlock- {
color: var(--ifm-color-white);
color: var(--ifm-color-white);
}
Copy link
Member

Choose a reason for hiding this comment

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

This was supposed to be removed as I mentioned. Will push the update.

@@ -14,11 +14,10 @@ import isInternalUrl from '@docusaurus/isInternalUrl';
import { useLocation } from '@docusaurus/router';

import SearchBar from '@theme/SearchBar';
import Toggle from '@theme/Toggle';
// import Toggle from '@theme/Toggle';
Copy link
Member

Choose a reason for hiding this comment

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

Why was this code commented out? Just delete it if that's your solution. I'll push the fix.

Comment on lines 137 to 140
// const onToggleChange = useCallback(
// e => (e.target.checked ? setDarkTheme() : setLightTheme()),
// [setLightTheme, setDarkTheme],
// );
Copy link
Member

Choose a reason for hiding this comment

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

Same, and you should have cleaned up the other code that used these values. I'll push.

Comment on lines 167 to 174
{/* {!disableDarkMode && (
<Toggle
className={styles.displayOnlyInLargeViewport}
aria-label="Dark mode toggle"
checked={isDarkTheme}
onChange={onToggleChange}
/>
)}
)} */}
Copy link
Member

Choose a reason for hiding this comment

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

Same as above. Don't comment code, just delete it. I'll push.

@phated phated merged commit 6e3e339 into gulpjs:source Apr 7, 2021
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.

1 participant