-
Notifications
You must be signed in to change notification settings - Fork 840
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
feat: move docusaurus website to packages directory #7815
Conversation
Preview staging links for this PR:
|
💚 Build Succeeded
cc @tkajtoch |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I checked the PR locally and yarn
, yarn start
and yarn build
all worked without issues.
I left two questions just for my own understanding, apart from that the PR looks fine to me (I did not check all the copied files though, I focused on the config and base files)
Using SSH: | ||
|
||
``` | ||
$ USE_SSH=true yarn deploy |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
❓ Is this autogenerated or important to us too?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is autogenerated. We'll replace it with a better readme once we have more things set up :)
import { EuiProvider } from '@elastic/eui'; | ||
import { Props } from '@theme/Root'; | ||
|
||
const c = createContext({}); | ||
|
||
// Wrap docusaurus root component with <EuiProvider> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
❓ Just to make sure I understand the Docusaurus swizzling correctly: We're actually not wrapping the Docusaurus root here but we're replacing it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can do both, depending on a component, but in this case, the original Root
is empty and is meant to be overridden like that
Summary
Closes #7644
This PR moves files from
feat/new-docs
to the newwebsite
package. As discussed a couple of of weeks prior, we don't need to keep the new EUI+ website on a feature branch since we have a monorepo structure and can work on it without interrupting the main package.No other code changes were made in this PR other than moving the files and adding copyright comments.
QA
Remove or strikethrough items that do not apply to your PR.
gh pr checkout 7815
), runyarn
, and confirm runningyarn start
inpackages/website
starts up the docusaurus development server without any errors reported