feat(docs): use gatsby-theme-patternfly-org by redallen · Pull Request #3146 · patternfly/patternfly-react · GitHub

Preview link: https://patternfly-react-pr-gatsby-theme-patternfly-org.surge.sh/patternfly-4/

What: Refactor docs to work with gatsby-theme-patternfly-org. Closes #2775, closes #2738, towards patternfly/patternfly-org#1208

New features:

Patternfly.org styling shared with patternfly-next and soon https://patternfly.org
Codesandbox links
Fullscreen example pages per-example

Additional issues:

Contribute page is broken. Needs to show contribution guidelines
Preview just now pushed to https://patternfly-react.surge.sh/patternfly-4 . This should be reverted the next time something is merged to master
Need to add support for dashes in title
Need to review all titles
Need to convert example SASS files to CSS and use proper selectors
Super long output with debug messages when running gatsby build
(followup) Table of content items containing spaces like Donut utilization chart don't work
(followup) Support pathPrefixed side nav item highlighting and example classNames via location.pathname
(followup) Alert margins to match https://pf4.patternfly.org/documentation/core/components/alert
(followup) Broken codesandboxes because of react-topology
(followup) React-router link usage formatting
(followup) Login page is broken
(followup) Nav needs dark background by default
(followup) Skip to content should be fullscreen only
(followup) Remove redundant table headers
(followup) Fix inline edit examples

…itle with spaces

…to css. Fixed Wizard examples not rendering and typo in Input Group Basic example

Codecov Report

❗ No coverage uploaded for pull request base (master@3a965e4). Click here to learn what that means.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             master    #3146   +/-   ##
=========================================
  Coverage          ?   68.98%           
=========================================
  Files             ?      858           
  Lines             ?    23627           
  Branches          ?     1893           
=========================================
  Hits              ?    16300           
  Misses            ?     6366           
  Partials          ?      961

Flag	Coverage Δ
#misc	95.45% <ø> (?)
#patternfly3	69.3% <ø> (?)
#patternfly4	67.95% <ø> (?)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3a965e4...467a161. Read the comment docs.

…youts and topology

…atternfly-react into gatsby-theme-patternfly-org

I'm going to stop reviewing here for now. The https://patternfly-react-gatsby-theme.surge.sh link doesn't appear to be in sync with the latest changes?

I understand the refactoring for the site, but feel the reformatting of titles, docs, etc. may be out of scope?

I don't see any API docs for charts and dark mode doesn't seem to be apply supported.

We have both RightLegend and RightAlignedLegend, which sound too similar. Could this be BarChartSimple. The prefix would help identify the example, especially while cutting/pasting examples

We could do this, but our current variable names for classes don't do this. Example: class MultiColorChart extends React.Component { in ChartThreshold.md does not include a Threshold prefix. I'm just going to keep shorter variable names for now that match the titles.

Edit: Fixing these specific examples because they have the exact same title and that's bad.

I'm not following the logic as to what these names must be? We can make the class names match whatever we choose -- that shouldn't be a deciding factor.

If I were to clean up afterward, can I not use BarChartSimple, BarChartMultiColor, BarCharRightLegend, etc.?

These can be anything. The only thing they matter for is what people copy/paste.

Discovered an issue with codesandbox. Seeing a "DependencyNotFoundError".

Could not find dependency: '@patternfly/react-charts' relative to '/index.js'

And the "Toggle dark theme" mode does not work with charts -- we don't support a dark theme, yet

…ernfly-org

Discovered an issue with codesandbox. Seeing a "DependencyNotFoundError".

Could not find dependency: '@patternfly/react-charts' relative to '/index.js'

@redallen I'm seeing a similar error when using the codesandbox link for the Toolbar layout:
Could not fetch version for @patternfly/react-toplogy@latest

@evwilkin That's on the followup checklist!

…ernfly-org

LGTM

Your changes have been released in:

@patternfly/react-charts@5.1.0
@patternfly/react-core@3.117.0
@patternfly/react-docs@4.15.0
gatsby-transformer-react-docgen-typescript@0.2.0
@patternfly/react-inline-edit-extension@2.12.0
demo-app-ts@3.7.14
@patternfly/react-styled-system@3.7.0
@patternfly/react-styles@3.6.0
@patternfly/react-table@2.24.0
@patternfly/react-tokens@2.7.0
@patternfly/react-topology@2.10.0
@patternfly/react-virtualized-extension@1.3.0

Thanks for your contribution! 🎉

redallen and others added 21 commits October 15, 2019 10:29

replace '## (.*)\njs title=' in md files

3445c73

chore(docs): replaced spaces with dashes in MD files where js title=T…

9fd69f2

…itle with spaces

examples are rendering

bf8d5bf

Add ## Examples for table of contents

7331abb

add example titles

4f396d1

bump plugin

bed30f9

fix(docs): created example folders for all components & updated scss …

7fcd955

…to css. Fixed Wizard examples not rendering and typo in Input Group Basic example

added title with withOuia and hiddenPages to gatsby-config

4172225

Moved experimental docs into examples directories

a6895ce

fix build in patternfly-react

526806e

fix theme

1f7cdc6

Update component titles

514c487

Update titles in layout, experimental, etc

e5a96f3

Missed one file

9ebb3cf

Switch and Text update

3bc82a9

fix copyStyles for submodule in submodule

38c0c0f

don't let gatsby use eslint

0510b89

bump theme version

9dd008e

fix PageLayout demos

beaba5d

fix icons page

51eee72

merge origin/master

c785d04

redallen mentioned this pull request Oct 15, 2019

Use gatsby-theme-patternfly-org #3131

Closed

bump versions

d6bb1a9

bump yarn.lock

59a20df

dlabrecq suggested changes Oct 15, 2019

View reviewed changes

redallen added the Do Not Merge label Oct 15, 2019

redallen and others added 3 commits October 16, 2019 13:04

Refactor chart docs for new theme

1b07d18

chore(docs): fixed hyphenated titles and converted scss to css for la…

d27f1a3

…youts and topology

Merge branch 'gatsby-theme-patternfly-org' of github.com:patternfly/p…

5854420

…atternfly-react into gatsby-theme-patternfly-org

dgutride reviewed Oct 16, 2019

View reviewed changes

Comment thread packages/patternfly-4/react-charts/src/components/ChartArea/examples/ChartArea.md

dlabrecq suggested changes Oct 16, 2019

View reviewed changes

charts titles, remove sass

2eb8041

redallen added 6 commits October 17, 2019 11:36

Chart content consistency

bfbb88c

bump theme

4717d5c

Merge remote-tracking branch 'upstream/master' into gatsby-theme-patt…

1019735

…ernfly-org

fix script syntax

b01c4fa

tweak upload script

a73b09b

Remove missing prop components

ed566ce

redallen removed the Do Not Merge label Oct 17, 2019

redallen requested review from dgutride and dlabrecq October 17, 2019 18:28

Update ChartBullet.md

cb3befe

dlabrecq previously approved these changes Oct 17, 2019

View reviewed changes

redallen requested review from dlabaj, jeff-phillips-18, jschuler and tlabaj October 17, 2019 19:23

use good gatsby+react version

e8d37c7

redallen dismissed dlabrecq’s stale review via e8d37c7 October 17, 2019 21:21

dlabrecq previously approved these changes Oct 17, 2019

View reviewed changes

Merge remote-tracking branch 'upstream/master' into gatsby-theme-patt…

467a161

…ernfly-org

redallen dismissed dlabrecq’s stale review via 467a161 October 18, 2019 13:21

tlabaj approved these changes Oct 18, 2019

View reviewed changes

dlabrecq approved these changes Oct 18, 2019

View reviewed changes

dlabrecq merged commit 93c843b into master Oct 18, 2019

-              <div>
-                <div className="bar-chart-legend-right">
+              RightLegend = (

feat(docs): use gatsby-theme-patternfly-org by redallen · Pull Request #3146 · patternfly/patternfly-react · GitHub

Uh oh!

feat(docs): use gatsby-theme-patternfly-org - #3146

feat(docs): use gatsby-theme-patternfly-org#3146dlabrecq merged 36 commits intomasterpatternfly/patternfly-react:masterfrom gatsby-theme-patternfly-orgpatternfly/patternfly-react:gatsby-theme-patternfly-orgCopy head branch name to clipboard

Conversation

redallen commented Oct 15, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-io commented Oct 15, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dlabrecq left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dlabrecq Oct 16, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

redallen Oct 16, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dlabrecq Oct 16, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

redallen Oct 17, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dlabrecq commented Oct 17, 2019

Uh oh!

evwilkin commented Oct 17, 2019

Uh oh!

redallen commented Oct 17, 2019

Uh oh!

tlabaj left a comment

Choose a reason for hiding this comment

Uh oh!

patternfly-build commented Oct 18, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

feat(docs): use gatsby-theme-patternfly-org#3146
dlabrecq merged 36 commits into
masterfrom
gatsby-theme-patternfly-org

redallen commented Oct 15, 2019 •
edited
Loading

codecov-io commented Oct 15, 2019 •
edited
Loading

dlabrecq left a comment •
edited
Loading

dlabrecq Oct 16, 2019 •
edited
Loading

redallen Oct 16, 2019 •
edited
Loading

dlabrecq Oct 16, 2019 •
edited
Loading