docs: add Get started: Developers #1439
Merged
Conversation
This file contains 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
|
✅ Deploy Preview for red-hat-design-system ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Size Change: 0 B Total Size: 248 kB ℹ️ View Unchanged
|
marionnegp
commented
Jan 18, 2024
marionnegp
commented
Jan 18, 2024
marionnegp
commented
Jan 18, 2024
marionnegp
commented
Jan 18, 2024
marionnegp
commented
Jan 18, 2024
zeroedin
reviewed
Jan 18, 2024
|
I'm seeing weirdness in the code blocks. Taking a look to see what I have to fix there. |
Code blocks should look correct now. |
bennypowers
reviewed
Apr 18, 2024
bennypowers
reviewed
Apr 18, 2024
nikkimk
pushed a commit
that referenced
this pull request
Apr 22, 2024
* docs: draft release notes * fix(tabs): improve long tab content with container queries (#1411) * fix(tabs): improve long tab content with container queries * chore(tabs): add changeset * docs(tabs): update long tab content * docs: update .changeset/silver-hornets-cry.md --------- Co-authored-by: Benny Powers - עם ישראל חי! <bennypowers@users.noreply.github.com> * feat(skip-link): add `<rh-skip-link>` (#1515) * feat(skip-link): add `<rh-skip-link>` * chore(skip-link): add changeset * docs(skip-link): add appropriate screenshot * fix: added lightdom-shim.css to export * chore: add Adam Johnson to contributors list * chore(skip-link): update readme * fix(skip-link): implement lightdom-shim * docs(skip-link): added JSDoc * docs(skip-link): enlarge screenshot * test(skip-link): add tests * chore(skip-link): lint tests * fix(skip-link): remove empty demo files * fix(skip-link): create container and move styles * fix(skip-link): reformat `.changeset` * fix(skip-link): add important to every CSS property * docs(skip-link): reformat `.changeset`. * fix(skip-link): Remove `!important` from lightdom shim. * fix(skip-link): set `font-size` * refactor(skip-link): change container `id` name * test(skip-link): refactor tests * feat: add more skip links docs content Note: There are a few images that still need to be added. * feat: add images to accessibility page * feat: add static image of skip link to Overview subpage * docs(skip-link): add sample element * feat: add deprecation alert to skip navigation page * test(skip-link): use `aTimeout` for focus test * feat: make the best practices more clear * docs(skip-link): add repoStatus * docs(skip-links): remove extraneous repoStatus shortcodes --------- Co-authored-by: marionnegp <mapatel@redhat.com> Co-authored-by: Steven Spriggs <steven.spriggs@gmail.com> * feat(back-to-top): add `<rh-back-to-top>` (#1517) * feat(back-to-top): add `<rh-back-to-top>` * chore(back-to-top): lint * fix(back-to-top): support dev server and docs demo * fix(back-to-top): suggestion for focus ring when on differnt backgrounds * docs(back-to-top): update readme * test(back-to-top): add tests * chore(back-to-top): add changeset * docs(back-to-top): remove comment * chore(back-to-top): update changeset with example * chore(back-to-top): remove unused demo.css * docs(back-to-top): improve screenshot * docs(back-to-top): attempt fix for playground view * fix(back-to-top): change attribute to visible="always" * docs(back-to-top): add back to top to repo status * docs: fix bug when component isnt yet in the repoStatus.yml * docs(back-to-top): update shortcodes for repoStatus --------- Co-authored-by: Benny Powers - עם ישראל חי! <bennypowers@users.noreply.github.com> * fix!: context types (#1518) * fix(lib)!: context types webcomponents-cg/community-protocols#59 made a breaking change to the way the context protocol works. This commit brings our types in line with the new types on the protocol * fix(context)!: adapt our contexts to new types see lit/lit#4614 and https://github.com/webcomponents-cg/community-protocols/pull/59/files * docs: create changeset --------- Co-authored-by: Steven Spriggs <steven.spriggs@gmail.com> * feat(code-block): actions and line numbers (#1496) * feat(code-block): wip extensions * feat(code-block): wrap * feat(code-block): show more * perf(code-block): don't clone to compute lines thanks @nikkimk! * feat(code-block): line numbers * feat(code-block): icons still tbd: switching text of toggle button from "toggle wrap" to "toggle overflow" - probably should be a pattern thing * fix(code-block): toggle slots for actions * fix(code-block): style adjustments * fix(code-block): classic css whoopsie * fix(code-block): gradient this was fun to debug. the key insight is that pseudo elements of a grid are *also* grid items * docs(code-block): changesets * docs(code-block): jsdoc * fix(code-block): review notes * docs(code-block): remove expandable demo it was decided (cc @coreyvickery) that expandable would automatically determined * docs(code-block): remove card with tabs demo should be revisited after PFE3/TabsAriaController * fix(code-block): refactor in anticipation of rh-fab * fix(code-block): polish up actions * fix(code-block): wrap fab state * fix(code-block): badge, not tag * fix: 🦄 * fix(code-block): remove actions slot * fix(code-block): expand button styles * fix(code-block): tooltip state in wrap * feat: update code for action buttons in color context demo --------- Co-authored-by: marionnegp <mapatel@redhat.com> * chore: update to @patternfly/pfe-core version 3.0 (#1508) * chore: update patternfly/elements dep to 3.0 * chore: update lit and typescript deps * chore: update typescript config and declaration * fix(tile): update internals controller instantiation * fix(button): update internals controller instantiation * fix(accordion): update rti api for setting active item * fix(menu): update rti api for setting active item * fix(navigation-secondary): update rti api for setting active item * fix(subnav): update rti api for setting active item * fix(tabs): update rti api for setting active item * chore: remove pfe elements from dep to a devDep add pfe-core as dep * docs(dialog): remove unneeded imports from demo * chore: lint * chore: update deps * test(tile): tile group a11y spec * chore: node version * docs: remove cases of band shortcode * docs: uxdot-search a11y tweaks * docs: 11ty plugins * docs: import package * fix(button): lint a11y in template * fix(audio-player): label dialog from it's opening button * chore: add playwright browser install to test workflow * fix(tooltip): a11y template linting * fix(tabs): use context instead of lightdom classes * docs: add @lit/context to importMap * style(tabs): lint css * fix(tabs) revert use context instead of lightdom classes * fix(tabs): Reverts 4b27d24 * chore: update lit/context to 1.1.1 * fix(menu): implement updated RTIC api * test(menu): remove pageup and pagedown tests reserved for scrolling page * refactor: no side effects in getters * test(footer): deflake tests * test(tooltip): assert on ax tree instead of shadow root * fix(tooltip): invert css to hide content until open / initialized * fix(tabs): use aria-tabs-controller * fix(tabs): refactor using pfe-core 3 * fix(tabs): tab context * fix(tabs): box context --------- Co-authored-by: Benny Powers <web@bennypowers.com> Co-authored-by: Benny Powers - עם ישראל חי! <bennypowers@users.noreply.github.com> * chore: eslint 9 (#1523) * chore: update linters * style: lint everything * chore: add optional dependency for rollup-darwin-x64 * style: lint line length and autofixes * chore: add .cache files to eslint ignore * style(tile): lint line length * style: more linting * fix(tile): replace mistakenly deleted expression * fix(navigation-secondary): query for all nav links update RTIC usage * fix(navigation-secondary): update items on slotchange * test(skip-link): visibility assertion --------- Co-authored-by: Steven Spriggs <steven.spriggs@gmail.com> * feat(site-status): add `<rh-site-status>` (#1507) * feat(site-status): add site-status * fix(site-status): add missing export * chore(site-stutus): fix comment * fix(site-status): lint * fix(site-status): add color-context * test(site-staus): fix missing semi colon * fix(site-status): remove errant import * fix(site-status): allow endpoint to be overridden * docs(site-status): add incorrect endpoint demo * docs(site-status): correct auto generated template for demo * test(site-status): improve tests * fix(site-status): lint * fix(site-status): lint * fix(site-status): ugh lint... * fix(site-status): revert customizable endpoint, add href to status page link * test(site-status): improve tests * docs(site-status): add status demos * docs(site-status): stub docs * docs(site-status): add jsdoc * docs: add site-status to related items * fix(site-status): add type guard for api response * docs(site-status): update readme * docs(site-status): imporove jsdoc * docs(site-status): add docs pages and images * chore(site-status): add changeset * chore(site-status): update changeset to include example * chore(site-status): remove unused demo files * fix(site-status): remove unused part * style(site-status): reorder type * fix(site-status): make #isApiStatus static * fix(site-status): class decorators cant be use with static private identifier * fix(site-status): move getStatus to firstUpdated, remove extraneous throw * fix(site-status): handle capitalization in css * fix(site-status): correct first letter uppercase style * fix(site-status): revert response error removal * fix(site-status): remove status as statusText includes the 404 text. * fix(site-status): correct viewbox attr * docs(site-status): add repoStatus * test(site-status): use sinon for fetch stub * test(site-status): remove unused aTimeout * fix(site-status): switch api call to a try catch * fix(site-status): remove contextProvider not used in design spec * fix(site-status): use block instead of display contents on host * fix(site-status): move restore of fetch to top describes * fix(site-status): implement loading-text slot for translations and accessibility with aria-polite and aria-busy * docs(site-status): improve demos with loading state demo * fix(site-status): add focus and hover states * docs(site-status): add if status is still loading to accessibility * fix(site-status): readding color context provider * chore(site-status): lint * fix(site-status): remove context provider add dark styles * docs(site-status): readding arg check to fetch override * chore(site-status): lint * docs: update .changeset/witty-papayas-tease.md * style: lint * feat: react wrappers (#1527) * docs: draft release notes * fix(tabs): improve long tab content with container queries (#1411) * fix(tabs): improve long tab content with container queries * chore(tabs): add changeset * docs(tabs): update long tab content * docs: update .changeset/silver-hornets-cry.md --------- Co-authored-by: Benny Powers - עם ישראל חי! <bennypowers@users.noreply.github.com> * feat(skip-link): add `<rh-skip-link>` (#1515) * feat(skip-link): add `<rh-skip-link>` * chore(skip-link): add changeset * docs(skip-link): add appropriate screenshot * fix: added lightdom-shim.css to export * chore: add Adam Johnson to contributors list * chore(skip-link): update readme * fix(skip-link): implement lightdom-shim * docs(skip-link): added JSDoc * docs(skip-link): enlarge screenshot * test(skip-link): add tests * chore(skip-link): lint tests * fix(skip-link): remove empty demo files * fix(skip-link): create container and move styles * fix(skip-link): reformat `.changeset` * fix(skip-link): add important to every CSS property * docs(skip-link): reformat `.changeset`. * fix(skip-link): Remove `!important` from lightdom shim. * fix(skip-link): set `font-size` * refactor(skip-link): change container `id` name * test(skip-link): refactor tests * feat: add more skip links docs content Note: There are a few images that still need to be added. * feat: add images to accessibility page * feat: add static image of skip link to Overview subpage * docs(skip-link): add sample element * feat: add deprecation alert to skip navigation page * test(skip-link): use `aTimeout` for focus test * feat: make the best practices more clear * docs(skip-link): add repoStatus * docs(skip-links): remove extraneous repoStatus shortcodes --------- Co-authored-by: marionnegp <mapatel@redhat.com> Co-authored-by: Steven Spriggs <steven.spriggs@gmail.com> * feat(back-to-top): add `<rh-back-to-top>` (#1517) * feat(back-to-top): add `<rh-back-to-top>` * chore(back-to-top): lint * fix(back-to-top): support dev server and docs demo * fix(back-to-top): suggestion for focus ring when on differnt backgrounds * docs(back-to-top): update readme * test(back-to-top): add tests * chore(back-to-top): add changeset * docs(back-to-top): remove comment * chore(back-to-top): update changeset with example * chore(back-to-top): remove unused demo.css * docs(back-to-top): improve screenshot * docs(back-to-top): attempt fix for playground view * fix(back-to-top): change attribute to visible="always" * docs(back-to-top): add back to top to repo status * docs: fix bug when component isnt yet in the repoStatus.yml * docs(back-to-top): update shortcodes for repoStatus --------- Co-authored-by: Benny Powers - עם ישראל חי! <bennypowers@users.noreply.github.com> * fix!: context types (#1518) * fix(lib)!: context types webcomponents-cg/community-protocols#59 made a breaking change to the way the context protocol works. This commit brings our types in line with the new types on the protocol * fix(context)!: adapt our contexts to new types see lit/lit#4614 and https://github.com/webcomponents-cg/community-protocols/pull/59/files * docs: create changeset --------- Co-authored-by: Steven Spriggs <steven.spriggs@gmail.com> * feat(code-block): actions and line numbers (#1496) * feat(code-block): wip extensions * feat(code-block): wrap * feat(code-block): show more * perf(code-block): don't clone to compute lines thanks @nikkimk! * feat(code-block): line numbers * feat(code-block): icons still tbd: switching text of toggle button from "toggle wrap" to "toggle overflow" - probably should be a pattern thing * fix(code-block): toggle slots for actions * fix(code-block): style adjustments * fix(code-block): classic css whoopsie * fix(code-block): gradient this was fun to debug. the key insight is that pseudo elements of a grid are *also* grid items * docs(code-block): changesets * docs(code-block): jsdoc * fix(code-block): review notes * docs(code-block): remove expandable demo it was decided (cc @coreyvickery) that expandable would automatically determined * docs(code-block): remove card with tabs demo should be revisited after PFE3/TabsAriaController * fix(code-block): refactor in anticipation of rh-fab * fix(code-block): polish up actions * fix(code-block): wrap fab state * fix(code-block): badge, not tag * fix: 🦄 * fix(code-block): remove actions slot * fix(code-block): expand button styles * fix(code-block): tooltip state in wrap * feat: update code for action buttons in color context demo --------- Co-authored-by: marionnegp <mapatel@redhat.com> * chore: update to @patternfly/pfe-core version 3.0 (#1508) * chore: update patternfly/elements dep to 3.0 * chore: update lit and typescript deps * chore: update typescript config and declaration * fix(tile): update internals controller instantiation * fix(button): update internals controller instantiation * fix(accordion): update rti api for setting active item * fix(menu): update rti api for setting active item * fix(navigation-secondary): update rti api for setting active item * fix(subnav): update rti api for setting active item * fix(tabs): update rti api for setting active item * chore: remove pfe elements from dep to a devDep add pfe-core as dep * docs(dialog): remove unneeded imports from demo * chore: lint * chore: update deps * test(tile): tile group a11y spec * chore: node version * docs: remove cases of band shortcode * docs: uxdot-search a11y tweaks * docs: 11ty plugins * docs: import package * fix(button): lint a11y in template * fix(audio-player): label dialog from it's opening button * chore: add playwright browser install to test workflow * fix(tooltip): a11y template linting * fix(tabs): use context instead of lightdom classes * docs: add @lit/context to importMap * style(tabs): lint css * fix(tabs) revert use context instead of lightdom classes * fix(tabs): Reverts 4b27d24 * chore: update lit/context to 1.1.1 * fix(menu): implement updated RTIC api * test(menu): remove pageup and pagedown tests reserved for scrolling page * refactor: no side effects in getters * test(footer): deflake tests * test(tooltip): assert on ax tree instead of shadow root * fix(tooltip): invert css to hide content until open / initialized * fix(tabs): use aria-tabs-controller * fix(tabs): refactor using pfe-core 3 * fix(tabs): tab context * fix(tabs): box context --------- Co-authored-by: Benny Powers <web@bennypowers.com> Co-authored-by: Benny Powers - עם ישראל חי! <bennypowers@users.noreply.github.com> * chore: eslint 9 (#1523) * chore: update linters * style: lint everything * chore: add optional dependency for rollup-darwin-x64 * style: lint line length and autofixes * chore: add .cache files to eslint ignore * style(tile): lint line length * style: more linting * fix(tile): replace mistakenly deleted expression * fix(navigation-secondary): query for all nav links update RTIC usage * fix(navigation-secondary): update items on slotchange * test(skip-link): visibility assertion --------- Co-authored-by: Steven Spriggs <steven.spriggs@gmail.com> * feat(site-status): add `<rh-site-status>` (#1507) * feat(site-status): add site-status * fix(site-status): add missing export * chore(site-stutus): fix comment * fix(site-status): lint * fix(site-status): add color-context * test(site-staus): fix missing semi colon * fix(site-status): remove errant import * fix(site-status): allow endpoint to be overridden * docs(site-status): add incorrect endpoint demo * docs(site-status): correct auto generated template for demo * test(site-status): improve tests * fix(site-status): lint * fix(site-status): lint * fix(site-status): ugh lint... * fix(site-status): revert customizable endpoint, add href to status page link * test(site-status): improve tests * docs(site-status): add status demos * docs(site-status): stub docs * docs(site-status): add jsdoc * docs: add site-status to related items * fix(site-status): add type guard for api response * docs(site-status): update readme * docs(site-status): imporove jsdoc * docs(site-status): add docs pages and images * chore(site-status): add changeset * chore(site-status): update changeset to include example * chore(site-status): remove unused demo files * fix(site-status): remove unused part * style(site-status): reorder type * fix(site-status): make #isApiStatus static * fix(site-status): class decorators cant be use with static private identifier * fix(site-status): move getStatus to firstUpdated, remove extraneous throw * fix(site-status): handle capitalization in css * fix(site-status): correct first letter uppercase style * fix(site-status): revert response error removal * fix(site-status): remove status as statusText includes the 404 text. * fix(site-status): correct viewbox attr * docs(site-status): add repoStatus * test(site-status): use sinon for fetch stub * test(site-status): remove unused aTimeout * fix(site-status): switch api call to a try catch * fix(site-status): remove contextProvider not used in design spec * fix(site-status): use block instead of display contents on host * fix(site-status): move restore of fetch to top describes * fix(site-status): implement loading-text slot for translations and accessibility with aria-polite and aria-busy * docs(site-status): improve demos with loading state demo * fix(site-status): add focus and hover states * docs(site-status): add if status is still loading to accessibility * fix(site-status): readding color context provider * chore(site-status): lint * fix(site-status): remove context provider add dark styles * docs(site-status): readding arg check to fetch override * chore(site-status): lint * docs: update .changeset/witty-papayas-tease.md * style: lint * feat: react wrapper components --------- Co-authored-by: Steven Spriggs <steven.spriggs@gmail.com> Co-authored-by: Adam Johnson <adam.b.johnson1@gmail.com> Co-authored-by: marionnegp <mapatel@redhat.com> * docs: add Get started: Developers (#1439) * feat: add content and update template * feat: add script tags to some code blocks * feat: fix page order and headings * fix: add script tags * feat: updated installation content and code on Tokens subpage * feat: change layout-with-subnav template and frontmatter * fix: Change the link in the side nav from "Overview" to "Developers" * feat: link to Developers page from Get Started: Overview * feat: add usage content and update installation info * fix: add script tags to code blocks * docs: update docs/get-started/developers/tokens.md * docs: update docs/get-started/developers/usage.md * docs: react usage --------- Co-authored-by: Benny Powers - עם ישראל חי! <bennypowers@users.noreply.github.com> Co-authored-by: Benny Powers <web@bennypowers.com> * docs: add <rh-back-to-top> content (#1526) * feat: add more back to top docs * fix: fix broken image links * feat: add static image in "Overview" section and note to view demo to see sample elemenet --------- Co-authored-by: Benny Powers - עם ישראל חי! <bennypowers@users.noreply.github.com> * fix(alert): body copy and button color (#1521) * feat: define color of body copy * feat: use rh-surface to wrap alert * docs: add changeset * fix(alert): make sure surface is available --------- Co-authored-by: Benny Powers - עם ישראל חי! <bennypowers@users.noreply.github.com> Co-authored-by: Benny Powers <web@bennypowers.com> * fix(menu): improve keyboard accessibility on firefox (#1529) * fix(menu): delegateFocus and on focus() set first active RTI element * fix(button): on focus() set shadow button to focus, firefox bug * docs(menu): remove slot=button elements from demos * fix(menu): move padding to ::slotted(a) * chore: add changeset * docs(menu): remove toggle button from color-context dmeo * chore: update changeset * fix: adds accents slot to rh-accordion-header (#1505) * added a part container * adds accents slot in rh-accordion-header * remove max-width from span * fixes lint error * creates a context for accents attribute * style: reduced font size for repo status hyperlink * fixes lint errors * Update accents conditional Co-authored-by: Steven Spriggs <steven.spriggs@gmail.com> * adds changeset * fixes wrapping issue in mobile view * fixes wrapping around the header text in mobile view * fix(accordion): use a container query for accents position * adds icon-set to rh-tag(s) --------- Co-authored-by: Steven Spriggs <steven.spriggs@gmail.com> * docs(tag): fix broken icons (#1531) docs(tag): fix icon names * chore: add a lit 3 patch changeset (#1533) chore: add changeset for dependencies upgrade * docs: Chansey release notes (#1532) * Updating release notes * Fixing release/d typo --------- Co-authored-by: Steven Spriggs <steven.spriggs@gmail.com> --------- Co-authored-by: Steven Spriggs <steven.spriggs@gmail.com> Co-authored-by: Adam Johnson <adam.b.johnson1@gmail.com> Co-authored-by: marionnegp <mapatel@redhat.com> Co-authored-by: Marionne Patel <95588923+marionnegp@users.noreply.github.com> Co-authored-by: Diwanshi Gadgil <diwanshipandey@gmail.com> Co-authored-by: Mark Caron <markcaron@users.noreply.github.com>
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 I did
Added content to a "Get Started: Developers" section.
Testing Instructions
Notes to Reviewers
For the "Installation" subpage, I used content from the elements' installation instructions. Content for the wrappers came from the PFE docs and edited to say RHDS instead.