Skip to content

Commit

Permalink
docs(support): adding Support page (#1642)
Browse files Browse the repository at this point in the history
* docs(support): adding Support page

* docs(support): added Get Support page and added top margin on backpage headings

* docs(support): fix links for design system help section

* docs(support): moved heading margin to flow CSS layer, reordered support tiles, and sentence cased the title

---------

Co-authored-by: Steven Spriggs <[email protected]>
  • Loading branch information
markcaron and zeroedin committed Jun 25, 2024
1 parent 460ac53 commit bb9495b
Show file tree
Hide file tree
Showing 5 changed files with 109 additions and 1 deletion.
6 changes: 6 additions & 0 deletions docs/_includes/partials/component/sidenav.njk
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,12 @@
</uxdot-sidenav-item>
</li>

<li>
<uxdot-sidenav-item>
<a href="{{ '/support/' | url }}">Get support</a>
</uxdot-sidenav-item>
</li>

{%- if runMode == 'watch' -%}
<li>
<uxdot-sidenav-item>
Expand Down
2 changes: 2 additions & 0 deletions docs/assets/javascript/elements/uxdot-copy-permalink.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ class UxdotCopyPermalink extends LitElement {
static styles = css`
:host {
display: flex;
margin-block-end: var(--rh-space-lg, 16px);
align-items: center;
}
Expand All @@ -32,6 +33,7 @@ class UxdotCopyPermalink extends LitElement {
::slotted(:is(h1, h2, h3, h4, h5, h6)) {
display: flex;
margin-block-end: 0 !important;
align-items: center;
color: inherit;
text-decoration: inherit;
Expand Down
2 changes: 1 addition & 1 deletion docs/styles/pages/backpage.css
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
/* not when the h2 is a child of a section */
.container > :not(section, uxdot-copy-permalink) > :where(uxdot-copy-permalink.h3, h3),
/* if a section landmark is used */
.container > section > :where(uxdot-copy-permalink.h3, h3){
.container > section > :where(uxdot-copy-permalink.h3, h3) {
margin-block-start: var(--rh-space-4xl, 64px);
}

Expand Down
4 changes: 4 additions & 0 deletions docs/styles/styles.css
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,10 @@
margin-block: var(--rh-space-md, 8px);
}

:where(h1, h2, h3, h4, h5, h6) {
margin-block-end: var(--rh-space-lg, 16px);
}

:where(h1, h2, h3, h4, h5, h6) + :where(h2, h3, h4, h5, h6),
/* any where copy-permalink is used as a sibling to another */
:where(uxdot-copy-permalink + uxdot-copy-permalink) {
Expand Down
96 changes: 96 additions & 0 deletions docs/support/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
---
layout: layouts/pages/basic.njk
title: Get support
hasToc: false
tags:
- support
importElements:
- rh-tile
- rh-tag
---

<link rel="stylesheet" href="{{ '/assets/packages/@rhds/elements/elements/rh-tile/rh-tile-lightdom.css' | url }}">
<style>
#contact-grid h3 {
display: flex;
gap: var(--rh-space-lg, 16px);
}
#support-footer-grid {
margin-block-start: var(--rh-space-6xl, 96px);
}
</style>

## Need help?

Find the best method for getting your question to the team.


## Connect on GitHub

The best way to get help or feedback is through GitHub. This allows us to pull your GitHub issue or discussion into our workflow more easily.


### Design system help

<div id="rhds-help-grid" class="grid sm-three-columns">
<rh-tile>
<h4 slot="headline"><a href="https://github.com/RedHat-UX/red-hat-design-system/issues/new?labels=bug&template=3-bug-report.yml&title=%5Bbug%5D+%3Ctitle%3E">File a bug report</a></h4>
If something is broken in an existing web component, submit a bug report and describe the error as thoroughly as possible.
</rh-tile>
<rh-tile>
<h4 slot="headline"><a href="https://github.com/RedHat-UX/red-hat-design-system/issues/new?assignees=&labels=feature,needs%20discovery&projects=&template=4-feature-request.yml&title=%5Bfeat%5D+%3Ctitle%3E">Request a feature or component</a></h4>
Help shape the design system’s roadmap by requesting new features or components.
</rh-tile>
<rh-tile>
<h4 slot="headline"><a href="https://github.com/orgs/RedHat-UX/discussions/new/choose">Start a discussion</a></h4>
Ask the community of Red Hat Design System users and contributors a question.
</rh-tile>
</div>


### Documentation and Figma help

<div id="docs-help-grid" class="grid sm-three-columns">
<rh-tile>
<h4 slot="headline"><a href="https://github.com/RedHat-UX/red-hat-design-system/issues/new?assignees=&labels=bug,docs&projects=&template=3-bug-report.yml&title=%5Bbug%5D+%3Ctitle%3E">Report a bug on ux.redhat.com</a></h4>
Submit an issue to fix bugs, like 404s, on ux.redhat.com.
</rh-tile>
<rh-tile>
<h4 slot="headline"><a href="https://github.com/orgs/RedHat-UX/discussions/new?category=documentation-feedback">Send documentation feedback</a></h4>
If you have general feedback about content on ux.redhat.com, start a discussion.
</rh-tile>
<rh-tile>
<h4 slot="headline"><a href="https://github.com/orgs/RedHat-UX/discussions/new?category=design-library-feedback">Submit design library feedback</a></h4>
Create a discussion to request new features or fixes for the Red Hat Design System’s Figma library.
</rh-tile>
</div>


## Contact us

<div id="contact-grid" class="grid sm-two-columns">
<div>
<h3>Find us on Slack <rh-tag color="red" variant="outline">Internal Red Hat users only</rh-tag></h3>
<p>We’re available at <strong>#red-hat-design-system</strong> for design, development, or accessibility questions.</p>
<p>Discussions about web components in general can be found in <strong>#list-web-components</strong>.</p>
</div>
<div>
<h3>Join office hours <rh-tag color="red" variant="outline">Internal Red Hat users only</rh-tag></h3>
<p>The Red Hat Design System team holds office hours weekly. The meeting time and link are in our <strong>#red-hat-design-system</strong> Slack channel bookmarks.</p>
</div>
<div>
<h3>Email us</h3>
<p>Send a message to <a href="mailto:[email protected]">[email protected]</a>.</p>
</div>
</div>

<div id="support-footer-grid" class="grid sm-two-columns">
<div>
<h2>Release notes</h2>
<p>To see what foundations, tokens, elements, or patterns have been released recently, check out our <a href="/release-notes/">release notes</a>.</p>
</div>
<div>
<h2>Roadmap</h2>
<p>To discover what we’re working on, take a look at our <a href="/about/roadmap/">roadmap</a>.</p>
</div>
</div>

0 comments on commit bb9495b

Please sign in to comment.