-
Notifications
You must be signed in to change notification settings - Fork 376
feat(gatsby): Refactor Gatsby #1656
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
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
|
PatternFly-React preview: https://1656-pr-patternfly-react-patternfly.surge.sh |
Contributor
Author
|
Finished howto docs + styles. This is ready to merge once tests pass. |
This was referenced Apr 1, 2019
Closed
dgutride
approved these changes
Apr 3, 2019
jschuler
approved these changes
Apr 3, 2019
Collaborator
jschuler
left a comment
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.
Awesome first step in redoing this @redallen . Couple things we can iterate on:
- Fix font size (html should be set to 16px so that rem units can pick it up)
- Font family should be Overpass everywhere
- Some components are not rendering (LoginPage, Background)
- Layouts should be in their own nav category
- Layouts don't have visual borders anymore
- Dark theme toggle button is missing
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What: Rewrite of React-docs. Still using Gatsby so v2 website development can continue.
A few key points for doc writers:
*.mdfiles transformed bygatsby-transformer-remark. This encourages writing more documentation and allows for a single source of truth of where doc pages come from (no having to import and linkexamples/*.jsfiles to our custom*.docs.jsfiles).Key points for contributors:
yarn start:pf4slightly decreased, and with clearer warning messages as to why resources or property tables might not be loading.Technical changes:
react-docgen-typescriptto replace build-time taskgen-ts-docsto allow hot reloading.examples/*.(js|svg)files as well as entire modules). This is the hardest part of the docs to understand and is handled inhelpers/dynamicImports.js. No more components are injected than need to be to keep page sizes smaller.@patternfly/reactcomponents in our docs is done safely by using"@patternfly/react-core": "2.9.2"in our package.json, but importing doing live code example imports viarequire("../../../react-core/dist/js"). This means if you break a component used in the docs (ie. Title) the whole doc website will not break but thecomponents/titlepage examples will break.Additional issues:
Still a a day or two of features to tackle:- [ ] Exclude inherited TS propsFuture work.