Skip to content

feat(docs): add react console documentation #3366

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.

Sign up for GitHub

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
nicolethoen merged 7 commits into from
Mar 1, 2023
Merged

feat(docs): add react console documentation #3366

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6a3f9a2
feat(docs): add react console documentation
wise-king-sullyman Jan 19, 2023
0b9956d
fix(docs): add loader for jsx to extensions
wise-king-sullyman Jan 19, 2023
75354b4
chore(docs): bump react console version
wise-king-sullyman Jan 19, 2023
e9979ec
chore(deps): bump console version
wise-king-sullyman Feb 1, 2023
10f3dac
chore(deps): bump console version
wise-king-sullyman Feb 2, 2023
95fca9a
fix(deps): re-added topology dependency
wise-king-sullyman Feb 6, 2023
6b8cc4c
chore(console): bump console version and generate screenshot
wise-king-sullyman Feb 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions packages/documentation-framework/scripts/webpack/webpack.base.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,12 @@ module.exports = (_env, argv) => {
include: [
path.resolve(process.cwd(), 'src'),
path.resolve(process.cwd(), 'patternfly-docs'),
path.resolve(process.cwd(), 'examples'),
path.resolve(__dirname, '../..'), // Temporarily compile theme using webpack for development
/react-[\w-]+\/src\/.*\/examples/,
/react-[\w-]+\\src\\.*\\examples/, // fix for Windows
/react-[\w-]+\/patternfly-docs\/.*\/examples/, //fixes for extensions
/react-[\w-]+\\patternfly-docs\\.*\\examples/,
].concat(includePaths.map(path => new RegExp(path))),
exclude: [
path.resolve(__dirname, '../../node_modules'), // Temporarily compile theme using webpack for development
Expand Down
1 change: 1 addition & 0 deletions packages/v4/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
"@patternfly/react-docs": "5.103.66",
"@patternfly/react-log-viewer": "4.87.100",
"@patternfly/react-topology": "^4.91.26",
"@patternfly/react-console": "^4.95.3",
"react": "^16.8.0 || ^17.0.0",
"react-dom": "^16.8.0 || ^17.0.0"
},
Expand Down
Binary file added ...ges/v4/patternfly-docs/generated/extensions/react-console/react/basic-usage.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions packages/v4/patternfly-docs/patternfly-docs.source.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,4 +114,12 @@ module.exports = (sourceMD, sourceProps) => {

sourceProps(path.join(reactCatalogViewSrcPath, "/**/*.tsx"), reactPropsIgnore);
sourceMD(path.join(reactCatalogViewDocsPath, '/**/examples/*.md'), 'react');

// Console extension
const consolePath = require.resolve("@patternfly/react-console/package.json");
const consoleDocsPath = consolePath.replace("package.json", "patternfly-docs/content/extensions/react-console");
const consoleSrcPath = consolePath.replace("package.json", "src/components");

sourceProps(path.join(consoleSrcPath, "/**/*.tsx"), reactPropsIgnore);
sourceMD(path.join(consoleDocsPath, "/examples/*.md"), 'react');
}
50 changes: 48 additions & 2 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2212,6 +2212,11 @@
"@nodelib/fs.scandir" "2.1.3"
fastq "^1.6.0"

"@novnc/novnc@^1.3.0":
version "1.3.0"
resolved "https://registry.yarnpkg.com/@novnc/novnc/-/novnc-1.3.0.tgz#06db5ff55eae646a623d3717d8bffaf131ffb93a"
integrity sha512-tR87mY5ADtaELadmZfW937JO/p8fRdz3wkPoqwhqB/vY1XnTQeLSWwkp4yMlr4iIDY0iCficfzFYX5EHMh4MHw==

"@npmcli/fs@^1.0.0":
version "1.1.1"
resolved "https://registry.yarnpkg.com/@npmcli/fs/-/fs-1.1.1.tgz#72f719fe935e687c56a4faecf3c03d06ba593257"
Expand Down Expand Up @@ -2366,6 +2371,11 @@
resolved "https://registry.yarnpkg.com/@patternfly/patternfly/-/patternfly-4.122.2.tgz#3e774d78996c7027b8c528edb2e90990676458a5"
integrity sha512-kSoW8mt9eEJcAZX2lX4r/SYvFd44GGb8PUSDjMrpKDZqgn9/9VFh1rSChG4v5kCK6cpS99/gdTapZc3ylf8Rpw==

"@patternfly/patternfly@4.224.1":
version "4.224.1"
resolved "https://registry.yarnpkg.com/@patternfly/patternfly/-/patternfly-4.224.1.tgz#67c74405ee2ddd2c74d758f21ad14e2cac485afc"
integrity sha512-ehUcWjBs2LMLw9DOQL7WgZ6dZmrszREQ0HIzQ76bjRpwL005oiJ7tRhxXX96BSGDGgm5mgGal8TgzVWbQJOUTw==

"@patternfly/patternfly@4.224.2":
version "4.224.2"
resolved "https://registry.yarnpkg.com/@patternfly/patternfly/-/patternfly-4.224.2.tgz#9d1b000c3c43457ae47c3556a334412d164fad90"
Expand Down Expand Up @@ -2443,6 +2453,22 @@
react-dropzone "9.0.0"
tslib "^2.0.0"

"@patternfly/react-console@^4.95.3":
version "4.95.3"
resolved "https://registry.yarnpkg.com/@patternfly/react-console/-/react-console-4.95.3.tgz#7005f5d05f9bd2420ce81847cc24ae68c17812b9"
integrity sha512-/FewUtvzJf6B3hK495zyCcHZMpY1iY/T5iyOym9B8mAVxkMfqLaruTUxa7C8tDXSEXLKUhRogaAcRE22c6sLzA==
dependencies:
"@novnc/novnc" "^1.3.0"
"@patternfly/patternfly" "4.224.1"
"@patternfly/react-core" "^4.273.3"
"@patternfly/react-styles" "^4.92.3"
"@spice-project/spice-html5" "^0.2.1"
"@types/file-saver" "^2.0.1"
file-saver "^1.3.8"
tslib "^2.0.0"
xterm "^4.8.1"
xterm-addon-fit "^0.2.1"

"@patternfly/react-core@^4.135.15":
version "4.224.1"
resolved "https://registry.yarnpkg.com/@patternfly/react-core/-/react-core-4.224.1.tgz#d8d81e7cf611fd441f9fb970db8e0c3a36fa508b"
Expand All @@ -2456,7 +2482,7 @@
tippy.js "5.1.2"
tslib "^2.0.0"

"@patternfly/react-core@^4.268.0", "@patternfly/react-core@^4.273.1", "@patternfly/react-core@^4.276.6":
"@patternfly/react-core@^4.268.0", "@patternfly/react-core@^4.273.1", "@patternfly/react-core@^4.273.3", "@patternfly/react-core@^4.276.6":
version "4.276.6"
resolved "https://registry.yarnpkg.com/@patternfly/react-core/-/react-core-4.276.6.tgz#fa39aa61022f70bf350b2efc660bdeb096bda447"
integrity sha512-G0K+378jf9jw9g+hCAoKnsAe/UGTRspqPeuAYypF2FgNr+dC7dUpc7/VkNhZBVqSJzUWVEK8NyXcqkfi0IemIg==
Expand Down Expand Up @@ -2606,6 +2632,11 @@
prop-types "^15.6.1"
react-lifecycles-compat "^3.0.4"

"@spice-project/spice-html5@^0.2.1":
version "0.2.1"
resolved "https://registry.yarnpkg.com/@spice-project/spice-html5/-/spice-html5-0.2.1.tgz#9452fc7435a8b1c67937d86ea3b6d6d7e0616725"
integrity sha512-NY86i+x/0ldKK89enXghsXCzWwfb5DQ91hQFu9hbyLcAfCVn+ZKoYsw7xUWX6/HQBRrdu/4F1id7SdOwNqpG9g==

"@testim/chrome-version@^1.1.2":
version "1.1.2"
resolved "https://registry.yarnpkg.com/@testim/chrome-version/-/chrome-version-1.1.2.tgz#092005c5b77bd3bb6576a4677110a11485e11864"
Expand Down Expand Up @@ -2888,6 +2919,11 @@
resolved "https://registry.yarnpkg.com/@types/dagre/-/dagre-0.7.42.tgz#2b0cd7678d5fc273df7816a88b8b34016e3a5d85"
integrity sha512-knVdi1Ul8xYgJ0wdhQ+/2YGJFKJFa/5srcPII9zvOs4KhsHfpnFrSTQXATYmjslglxRMif3Lg+wEZ0beag+94A==

"@types/file-saver@^2.0.1":
version "2.0.5"
resolved "https://registry.yarnpkg.com/@types/file-saver/-/file-saver-2.0.5.tgz#9ee342a5d1314bb0928375424a2f162f97c310c7"
integrity sha512-zv9kNf3keYegP5oThGLaPk8E081DFDuwfqjtiTzm6PoxChdJ1raSuADf2YGCVIyrSynLrgc8JWv296s7Q7pQSQ==

"@types/geojson@*":
version "7946.0.7"
resolved "https://registry.yarnpkg.com/@types/geojson/-/geojson-7946.0.7.tgz#c8fa532b60a0042219cdf173ca21a975ef0666ad"
Expand Down Expand Up @@ -6653,7 +6689,7 @@ file-name@^0.1.0:
resolved "https://registry.yarnpkg.com/file-name/-/file-name-0.1.0.tgz#12b122f120f9c34dbc176c1ab81a548aced6def7"
integrity sha1-ErEi8SD5w028F2wauBpUis7W3vc=

file-saver@1.3.8:
file-saver@1.3.8, file-saver@^1.3.8:
version "1.3.8"
resolved "https://registry.yarnpkg.com/file-saver/-/file-saver-1.3.8.tgz#e68a30c7cb044e2fb362b428469feb291c2e09d8"
integrity sha512-spKHSBQIxxS81N/O21WmuXA2F6wppUCsutpzenOeZzOCCJ5gEfcbqJP983IrpLXzYmXnMUa6J03SubcNPdKrlg==
Expand Down Expand Up @@ -14529,6 +14565,16 @@ xtend@^4.0.0, xtend@^4.0.1, xtend@~4.0.1:
resolved "https://registry.yarnpkg.com/xtend/-/xtend-4.0.2.tgz#bb72779f5fa465186b1f438f674fa347fdb5db54"
integrity sha512-LKYU1iAXJXUgAXn9URjiu+MWhyUXHsvfp7mcuYm9dSUKK0/CjtrUwFAxD82/mCWbtLsGjFIad0wIsod4zrTAEQ==

xterm-addon-fit@^0.2.1:
version "0.2.1"
resolved "https://registry.yarnpkg.com/xterm-addon-fit/-/xterm-addon-fit-0.2.1.tgz#353f43921eb78e3f9ad3f3afbb14e7ac183ca738"
integrity sha512-BlR57O3t1/bmVcnS81bn9ZnNf+GiGNbeXdNUKSBa9tKEwNUMcU3S+KFLIRv7rm1Ty0D5pMOu0vbz/RDorKRwKQ==

xterm@^4.8.1:
version "4.19.0"
resolved "https://registry.yarnpkg.com/xterm/-/xterm-4.19.0.tgz#c0f9d09cd61de1d658f43ca75f992197add9ef6d"
integrity sha512-c3Cp4eOVsYY5Q839dR5IejghRPpxciGmLWWaP9g+ppfMeBChMeLa1DCA+pmX/jyDZ+zxFOmlJL/82qVdayVoGQ==

y18n@^3.2.1:
version "3.2.1"
resolved "https://registry.yarnpkg.com/y18n/-/y18n-3.2.1.tgz#6d15fba884c08679c0d77e88e7759e811e07fa41"
Expand Down