-
Notifications
You must be signed in to change notification settings - Fork 146
docs(design-tokens): Creates docs for design tokens. #3786
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
Conversation
packages/documentation-site/patternfly-docs/patternfly-docs.config.js
Outdated
Show resolved
Hide resolved
|
So, I can't seem to get these pages properly added to the preview site (if anyone can lmk how I'll make that change so that the preview is nice and pretty), but wanted to share my initial structure & writing for design tokens docs if you have any input at this point pls share! tagging a variety of ppl whose names I've seen in these convos: @andrew-ronaldson @lboehling @srambach @mcoker @nicolethoen |
|
About the pages in the sidebar, you'll also want to add an entry for the design tokens page here - https://github.com/edonehoo/patternfly-org/blob/iss1258/packages/documentation-site/patternfly-docs/patternfly-docs.source.js#L13-L18 You'll add: And add a |
|
this is looking good! I think the contents of the |
srambach
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.
Great start to this!
I intentionally didn't look ahead to where the docs would exist. When I first opened the preview, I first went to Developer resources, global CSS variables. Then I opened Design Foundations thinking it might be mixed with colors, spacers, etc. I do think tokens merit their own section, but we should do some good cross linking and also update the docs where we talk about the old global variables that really aren't going to be used any more.
Thanks for working on this!
packages/documentation-site/patternfly-docs/content/design-tokens/design-tokens.md
Outdated
Show resolved
Hide resolved
packages/documentation-site/patternfly-docs/content/design-tokens/design-tokens.md
Outdated
Show resolved
Hide resolved
packages/documentation-site/patternfly-docs/content/design-tokens/design-tokens.md
Outdated
Show resolved
Hide resolved
packages/documentation-site/patternfly-docs/content/design-tokens/design-tokens.md
Outdated
Show resolved
Hide resolved
packages/documentation-site/patternfly-docs/content/design-tokens/design-tokens.md
Outdated
Show resolved
Hide resolved
packages/documentation-site/patternfly-docs/content/design-tokens/design-tokens.md
Outdated
Show resolved
Hide resolved
|
|
||
| Palette layer tokens contain the colors in [PatternFly color palettes](/design-foundations/colors#patternfly-palettes). | ||
|
|
||
| If you've used PatternFly previously, these values resemble some of the CSS variables that you may be familiar with. They |
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.
Some of our other tokens are quite like existing CSS variables, too, like spacers and status colors. Maybe @lboehling would have some good words for describing the palette layer?
packages/documentation-site/patternfly-docs/content/design-tokens/design-tokens.md
Outdated
Show resolved
Hide resolved
packages/documentation-site/patternfly-docs/content/design-tokens/design-tokens.md
Outdated
Show resolved
Hide resolved
- @patternfly/ast-helpers@1.2.21 - @patternfly/documentation-framework@5.2.21
- @patternfly/ast-helpers@1.2.22 - @patternfly/documentation-framework@5.2.22
- @patternfly/ast-helpers@1.2.23 - @patternfly/documentation-framework@5.2.23
…3782) * docs(design-guidelines) Updates content for consistency. * Updates from review.
- @patternfly/ast-helpers@1.2.24 - @patternfly/documentation-framework@5.2.24
* chore(docs-framework): add class on example load * chore(example): remove dev mode check from page loaded class addition * chore(example): refactor to add class on page load event
- @patternfly/ast-helpers@1.3.15-alpha.8 - @patternfly/documentation-framework@6.0.0-alpha.9
- @patternfly/ast-helpers@1.3.15-alpha.9 - @patternfly/documentation-framework@6.0.0-alpha.10
|
@andrew-ronaldson @srambach @jessiehuff @lboehling @nicolethoen @mcoker hi! tokens docs are further along and ready for another look
open to all thoughts and ideas :-) |
|
My understanding is that there may come a time that the text descriptions of the tokens might be able to come out of figma? And live in the design tokens repo? Either way, my auto generated table will live in the design-token repo, so that's where the text would need to be added. Hopefully I can add it to this PR, i'm still getting stuck on a build issue i've got to resolve. |
andrew-ronaldson
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.
Approved!
srambach
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.
Thanks @edonehoo!
* docs(design-tokens): creates documentation for design tokens. * Working on design tokens doc structure. * Continues adding content and outlining the docs structure. * Ready design tokens docs for draft preview. * Update page info. * Add to side nav. * Adjust section label. * Update packages/documentation-site/patternfly-docs/patternfly-docs.config.js * Small typos. * Update sidebar.' q * Updates to the charts about page and charts colors page (patternfly#3759) * Updates to the charts about page and charts colors page * Update to Color-and-pattern-usage image file * Update colors-for-charts.md * Update colors-for-charts.md --------- Co-authored-by: Margot <51165119+mmenestr@users.noreply.github.com> * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.2.21 - @patternfly/documentation-framework@5.2.21 * Update broken links on menu accessibility docs * Update broken links on menu design guidelines * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.2.22 - @patternfly/documentation-framework@5.2.22 * Removing the redudancy in the file. Use is described above the text. (patternfly#3790) * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.2.23 - @patternfly/documentation-framework@5.2.23 * docs(design-guidelines) Updates content for consistency. (patternfly#3782) * docs(design-guidelines) Updates content for consistency. * Updates from review. * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.2.24 - @patternfly/documentation-framework@5.2.24 * chore(docs-framework): add class on example load (patternfly#3789) * chore(docs-framework): add class on example load * chore(example): remove dev mode check from page loaded class addition * chore(example): refactor to add class on page load event * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.2.25 - @patternfly/documentation-framework@5.2.25 * docs(terminology): Updates n/a and -- descriptions for clarity. (patternfly#3783) * docs(terminology): Updates n/a and -- descriptions for clarity. * Update packages/documentation-site/patternfly-docs/content/design-guidelines/content/terminology.md * Update packages/documentation-site/patternfly-docs/content/design-guidelines/content/terminology.md * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.2.26 - @patternfly/documentation-framework@5.2.26 * feat(dark-theme): replace dark theme switcher with toggle group (patternfly#3788) * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.3.0 - @patternfly/documentation-framework@5.3.0 * chore(JumpLinks): updated a11y docs to match template (patternfly#3808) * fix(react-drag-drop): add react-drag-drop to latest version (patternfly#3801) * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.3.1 - @patternfly/documentation-framework@5.3.1 * fix: clean up versions and showdown deps (patternfly#3816) * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.3.2 - @patternfly/documentation-framework@5.3.2 * Added expand/collapse all cards info (patternfly#3815) * Added expand/collapse all cards info * Update card-view.md * Update card-view.md --------- Co-authored-by: Margot <51165119+mmenestr@users.noreply.github.com> * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.3.3 - @patternfly/documentation-framework@5.3.3 * fix: add charts dark theme stylesheet (patternfly#3802) * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.3.4 - @patternfly/documentation-framework@5.3.4 * fix(drag drop): add drag drop to 5.1 versions.json (patternfly#3817) * fix(react-drag-drop): add react-drag-drop to latest version * fix(drag drop): add to 5.1 version * remove form 5.0 * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.3.5 - @patternfly/documentation-framework@5.3.5 * fix: add virtualized table to extensions staging (patternfly#3819) * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.3.6 - @patternfly/documentation-framework@5.3.6 * chore(Sidebar): updated a11y docs (patternfly#3813) * chore(AboutModal): updated a11y docs to match template (patternfly#3796) * chore(AboutModal): updated a11y docs to match template * Added alt text content to additional sections * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.3.7 - @patternfly/documentation-framework@5.3.7 * Makes some content updates. * fix: prepare org for component groups release (patternfly#3822) * fix: prepare org for component groups release * bump to component groups to 5.0.0 * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.3.8 - @patternfly/documentation-framework@5.3.8 * Update github actions to add new issues to project board (patternfly#3818) * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.3.9 - @patternfly/documentation-framework@5.3.9 * docs(accessibility-fundamentals): Updates content as part of audit. (patternfly#3762) * docs(accessibility-fundamentals): Updates content as part of audit. * Updates content and adjusts file name. * Content tweaks. * Update packages/documentation-site/patternfly-docs/content/developer-resources/accessibility-fundamentals.md * Test page name change * Update packages/documentation-site/patternfly-docs/content/developer-resources/accessibility-fundamentals.md * Some final tweaking to ready draft for review. * Apply suggestions from code review Co-authored-by: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> * Update packages/documentation-site/patternfly-docs/content/developer-resources/accessibility-fundamentals.md * Updates to file name. --------- Co-authored-by: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> * docs(patternfly-accessibility): Updates content as part of content audit. (patternfly#3772) * docs(patternfly-accessibility): Updates content as part of content audit. * Update packages/documentation-site/patternfly-docs/content/developer-resources/patternfly-accessibility.md * Update packages/documentation-site/patternfly-docs/content/developer-resources/patternfly-accessibility.md Co-authored-by: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> * Apply suggestions from code review * Update packages/documentation-site/patternfly-docs/content/developer-resources/patternfly-accessibility.md * Update packages/documentation-site/patternfly-docs/content/developer-resources/patternfly-accessibility.md Co-authored-by: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> --------- Co-authored-by: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> * docs(accessibility-development): Updates documentation as part of content audit. (patternfly#3780) * docs(accessibility-development): Updates documentation as part of content audit. * Test adding screen reader info here. * Test name change to adjust nav * Apply suggestions from code review Co-authored-by: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> * Update packages/documentation-site/patternfly-docs/content/developer-resources/accessibility-development.md * Update packages/documentation-site/patternfly-docs/content/developer-resources/accessibility-development.md * Updates content. * Apply suggestions from code review * Update packages/documentation-site/patternfly-docs/content/developer-resources/accessibility-development.md * Updates development techniques table content. * Continues editing content. * Content updates. --------- Co-authored-by: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> * docs(accessibility-scorecard): Updates content as part of content audit. (patternfly#3774) * docs(accessibility-scorecard): Updates content as part of content audit. * Update packages/documentation-site/patternfly-docs/content/developer-resources/accessibility-scorecard.md * Final tweaks to ready content for review. * Updates content. * chore(deps): add react as a dep at the root level (patternfly#3834) * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.3.10 - @patternfly/documentation-framework@5.3.10 * chore(Skeleton): updated a11y docs to match template (patternfly#3824) * chore(HelperText): updated a11y docs to match template (patternfly#3805) * chore(HelperText): updated a11y docs to match template * Removed interactive content bullet from design guidelines * chore(ExpandableSection): updated a11y docs to match template (patternfly#3803) * chore(ExpandableSection): updated a11y docs to match template * Added content regarding multiple sections on a page * Added atttributes to html table * chore(CodeEditor): updated a11y documentation to match template (patternfly#3799) * chore(CodeEditor): updated a11y documentation to match template * Removed unused import * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.3.11 - @patternfly/documentation-framework@5.3.11 * chore(deps): bump semver from 5.7.1 to 5.7.2 (patternfly#3841) Bumps [semver](https://github.com/npm/node-semver) from 5.7.1 to 5.7.2. - [Release notes](https://github.com/npm/node-semver/releases) - [Changelog](https://github.com/npm/node-semver/blob/v5.7.2/CHANGELOG.md) - [Commits](npm/node-semver@v5.7.1...v5.7.2) --- updated-dependencies: - dependency-name: semver dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump @babel/traverse from 7.18.6 to 7.23.6 (patternfly#3842) Bumps [@babel/traverse](https://github.com/babel/babel/tree/HEAD/packages/babel-traverse) from 7.18.6 to 7.23.6. - [Release notes](https://github.com/babel/babel/releases) - [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md) - [Commits](https://github.com/babel/babel/commits/v7.23.6/packages/babel-traverse) --- updated-dependencies: - dependency-name: "@babel/traverse" dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.3.12 - @patternfly/documentation-framework@5.3.12 * docs(level): expands design guidelines for level layout. (patternfly#3673) * docs: expands design guidelines for level layout. * Expands content. * Image placeholders. * Adds content to ready for review. * Apply suggestions from code review * Remove image placeholders * [Snyk] Fix for 1 vulnerabilities (patternfly#3828) * fix: packages/documentation-framework/package.json to reduce vulnerabilities The following vulnerabilities are fixed with an upgrade: - https://snyk.io/vuln/SNYK-JS-INFLIGHT-6095116 * address breaking change in glob * more version bumps * update screenshot command --------- Co-authored-by: snyk-bot <snyk-bot@snyk.io> Co-authored-by: nicolethoen <nthoen@redhat.com> * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.3.13 - @patternfly/documentation-framework@5.3.13 * chore(deps): bump postcss from 8.4.31 to 8.4.32 (patternfly#3844) Bumps [postcss](https://github.com/postcss/postcss) from 8.4.31 to 8.4.32. - [Release notes](https://github.com/postcss/postcss/releases) - [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md) - [Commits](postcss/postcss@8.4.31...8.4.32) --- updated-dependencies: - dependency-name: postcss dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.3.14 - @patternfly/documentation-framework@5.3.14 * [Snyk] Security upgrade puppeteer from 18.2.0 to 19.7.3 (patternfly#3843) * fix: packages/documentation-framework/package.json to reduce vulnerabilities The following vulnerabilities are fixed with an upgrade: - https://snyk.io/vuln/SNYK-JS-INFLIGHT-6095116 * update yarn.lock --------- Co-authored-by: snyk-bot <snyk-bot@snyk.io> Co-authored-by: nicolethoen <nthoen@redhat.com> * chore(deps): bump qs from 6.5.2 to 6.5.3 (patternfly#3309) Bumps [qs](https://github.com/ljharb/qs) from 6.5.2 to 6.5.3. - [Release notes](https://github.com/ljharb/qs/releases) - [Changelog](https://github.com/ljharb/qs/blob/main/CHANGELOG.md) - [Commits](ljharb/qs@v6.5.2...v6.5.3) --- updated-dependencies: - dependency-name: qs dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * fix: try a v6 release * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.3.15-alpha.0 - @patternfly/documentation-framework@6.0.0-alpha.1 * fix: use surge for v6 staging rather than aws bucket * fix: bump docs-framework version in docs-site * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.3.15-alpha.1 - @patternfly/documentation-framework@6.0.0-alpha.2 * fix: try publish v6 to aws (patternfly#3845) * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.3.15-alpha.2 - @patternfly/documentation-framework@6.0.0-alpha.3 * fix: update white space to test publishing to aws * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.3.15-alpha.3 - @patternfly/documentation-framework@6.0.0-alpha.4 * fix: PF brand logo in masthead to inline svg * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.3.15-alpha.4 - @patternfly/documentation-framework@6.0.0-alpha.5 * fix: bump puppeteer (patternfly#3858) * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.3.15-alpha.5 - @patternfly/documentation-framework@6.0.0-alpha.6 * fix: Update brand svg id to avoid duplicate ids * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.3.15-alpha.6 - @patternfly/documentation-framework@6.0.0-alpha.7 * Fix: update logo svg (patternfly#3861) * fix: update logo svg * fix: update logo svg * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.3.15-alpha.7 - @patternfly/documentation-framework@6.0.0-alpha.8 * fix: Update versions.json to include drag drop alpha * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.3.15-alpha.8 - @patternfly/documentation-framework@6.0.0-alpha.9 * fix: bump docs framework version * chore(release): releasing packages [ci skip] - @patternfly/ast-helpers@1.3.15-alpha.9 - @patternfly/documentation-framework@6.0.0-alpha.10 * Continued edits. * Working on content. * Updates design info and adds images. * Updates to images. * Continued content updates. * Smooths out formatting and content. * add all tokens documentation * bump to design-tokens version with versioned css --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: aratti96 <105744045+aratti96@users.noreply.github.com> Co-authored-by: Margot <51165119+mmenestr@users.noreply.github.com> Co-authored-by: patternfly-build <patternfly-build@redhat.com> Co-authored-by: Nicole Thoen <nthoen@redhat.com> Co-authored-by: kuklas <78739379+kuklas@users.noreply.github.com> Co-authored-by: Austin Sullivan <ausulliv@redhat.com> Co-authored-by: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Co-authored-by: kmcfaul <45077788+kmcfaul@users.noreply.github.com> Co-authored-by: Katie Edwards <94569315+kaedward@users.noreply.github.com> Co-authored-by: Jessie <jhuff@redhat.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Patternfly Build <patternfly-build@users.noreply.github.com> Co-authored-by: snyk-bot <snyk-bot@snyk.io>
Closes #1258