From 3d17078c5deef1a27a3dd561d592e53b2551a75f Mon Sep 17 00:00:00 2001 From: Mark Caron Date: Tue, 18 Jun 2024 15:12:18 -0400 Subject: [PATCH 1/4] docs(support): adding Support page --- docs/_includes/partials/component/sidenav.njk | 6 ++ docs/support/index.md | 65 +++++++++++++++++++ 2 files changed, 71 insertions(+) create mode 100644 docs/support/index.md diff --git a/docs/_includes/partials/component/sidenav.njk b/docs/_includes/partials/component/sidenav.njk index f06aabf46b..b51890c45f 100644 --- a/docs/_includes/partials/component/sidenav.njk +++ b/docs/_includes/partials/component/sidenav.njk @@ -86,6 +86,12 @@ +
  • + + Get support + +
  • + {%- if runMode == 'watch' -%}
  • diff --git a/docs/support/index.md b/docs/support/index.md new file mode 100644 index 0000000000..19ec3b3d4f --- /dev/null +++ b/docs/support/index.md @@ -0,0 +1,65 @@ +--- +layout: layouts/pages/basic.njk +title: Get Support +hasToc: true +tags: + - support +importElements: + - rh-tile + - rh-tag +--- + + + + +## 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 + + + + +### Documentation and Figma help + +
    + +

    Send documentation feedback

    + If you have general feedback about content on ux.redhat.com, start a discussion. +
    + +

    Report a bug on ux.redhat.com

    + Submit an issue to fix bugs, like 404s, on ux.redhat.com. +
    + +

    Submit design library feedback

    + Create a discussion to request new features or fixes for the Red Hat Design System’s Figma library. +
    +
    + + +## Contact us + +
    +
    +

    Find us on Slack Internal Red Hat users only

    +

    We’re available at #red-hat-design-system for design, development, or accessibility questions.

    +

    Discussions about web components in general can be found in #list-web-components.

    +
    +
    +

    Join office hours Internal Red Hat users only

    +

    The Red Hat Design System team holds office hours twice a week. Our meeting time and link is available in our #red-hat-design-system Slack channel bookmarks.

    +
    +
    + + +### Email us + +Send a message to design-system@redhat.com. \ No newline at end of file From b8778fb6454bcd577b00ce3f5a9963c8e0d35fe5 Mon Sep 17 00:00:00 2001 From: Mark Caron Date: Thu, 20 Jun 2024 09:34:26 -0400 Subject: [PATCH 2/4] docs(support): added Get Support page and added top margin on backpage headings --- docs/styles/pages/backpage.css | 3 +++ docs/support/index.md | 43 ++++++++++++++++++++++++++++++---- 2 files changed, 41 insertions(+), 5 deletions(-) diff --git a/docs/styles/pages/backpage.css b/docs/styles/pages/backpage.css index 14aedd650e..c3873ebefc 100644 --- a/docs/styles/pages/backpage.css +++ b/docs/styles/pages/backpage.css @@ -77,6 +77,7 @@ /* if a section landmark is used */ .container > section > :where(uxdot-copy-permalink.h2, h2) { margin-block-start: var(--rh-space-6xl, 96px); + margin-block-end: var(--rh-space-2xl, 32px); } /* TODO: get rid of inline style/link/script tags inside of container @@ -102,6 +103,7 @@ /* if a section landmark is used */ .container > section > :where(uxdot-copy-permalink.h3, h3){ margin-block-start: var(--rh-space-4xl, 64px); + margin-block-end: var(--rh-space-2xl, 32px); } /* @@ -115,6 +117,7 @@ /* if a section landmark is used */ .container > section > :where(uxdot-copy-permalink.h4, h4) { margin-block-start: var(--rh-space-3xl, 48px); + margin-block-end: var(--rh-space-lg, 16px); } @container main (min-width: 576px) { diff --git a/docs/support/index.md b/docs/support/index.md index 19ec3b3d4f..662e12e005 100644 --- a/docs/support/index.md +++ b/docs/support/index.md @@ -1,7 +1,7 @@ --- layout: layouts/pages/basic.njk title: Get Support -hasToc: true +hasToc: false tags: - support importElements: @@ -10,7 +10,15 @@ importElements: --- - + ## Need help? @@ -24,7 +32,20 @@ The best way to get help or feedback is through GitHub. This allows us to pull y ### Design system help - +
    + +

    File a bug report

    + If something is broken in an existing web component, submit a bug report and describe the error as thoroughly as possible. +
    + +

    Request a feature or component

    + Help shape the design system’s roadmap by requesting new features or components. +
    + +

    Start a discussion

    + Ask the community of Red Hat Design System users and contributors a question. +
    +
    ### Documentation and Figma help @@ -55,11 +76,23 @@ The best way to get help or feedback is through GitHub. This allows us to pull y

    Join office hours Internal Red Hat users only

    -

    The Red Hat Design System team holds office hours twice a week. Our meeting time and link is available in our #red-hat-design-system Slack channel bookmarks.

    +

    The Red Hat Design System team holds office hours weekly. The meeting time and link are in our #red-hat-design-system Slack channel bookmarks.

    ### Email us -Send a message to design-system@redhat.com. \ No newline at end of file +Send a message to design-system@redhat.com. + + + \ No newline at end of file From 81dc65d62eca88ab9ad8c915b78b212440fb06df Mon Sep 17 00:00:00 2001 From: Mark Caron Date: Thu, 20 Jun 2024 09:54:26 -0400 Subject: [PATCH 3/4] docs(support): fix links for design system help section --- docs/support/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/support/index.md b/docs/support/index.md index 662e12e005..0d25fcfe12 100644 --- a/docs/support/index.md +++ b/docs/support/index.md @@ -34,15 +34,15 @@ The best way to get help or feedback is through GitHub. This allows us to pull y
    -

    File a bug report

    +

    File a bug report

    If something is broken in an existing web component, submit a bug report and describe the error as thoroughly as possible.
    -

    Request a feature or component

    +

    Request a feature or component

    Help shape the design system’s roadmap by requesting new features or components.
    -

    Start a discussion

    +

    Start a discussion

    Ask the community of Red Hat Design System users and contributors a question.
    @@ -56,7 +56,7 @@ The best way to get help or feedback is through GitHub. This allows us to pull y If you have general feedback about content on ux.redhat.com, start a discussion. -

    Report a bug on ux.redhat.com

    +

    Report a bug on ux.redhat.com

    Submit an issue to fix bugs, like 404s, on ux.redhat.com.
    From 10b7f5b3b5f5bc61195c588dade5176e2c158ea0 Mon Sep 17 00:00:00 2001 From: Mark Caron Date: Fri, 21 Jun 2024 12:38:55 -0400 Subject: [PATCH 4/4] docs(support): moved heading margin to flow CSS layer, reordered support tiles, and sentence cased the title --- .../elements/uxdot-copy-permalink.js | 2 ++ docs/styles/pages/backpage.css | 5 +---- docs/styles/styles.css | 4 ++++ docs/support/index.md | 20 +++++++++---------- 4 files changed, 16 insertions(+), 15 deletions(-) diff --git a/docs/assets/javascript/elements/uxdot-copy-permalink.js b/docs/assets/javascript/elements/uxdot-copy-permalink.js index 90ad66056e..5f59ea2e56 100644 --- a/docs/assets/javascript/elements/uxdot-copy-permalink.js +++ b/docs/assets/javascript/elements/uxdot-copy-permalink.js @@ -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; } @@ -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; diff --git a/docs/styles/pages/backpage.css b/docs/styles/pages/backpage.css index c3873ebefc..01c58e019f 100644 --- a/docs/styles/pages/backpage.css +++ b/docs/styles/pages/backpage.css @@ -77,7 +77,6 @@ /* if a section landmark is used */ .container > section > :where(uxdot-copy-permalink.h2, h2) { margin-block-start: var(--rh-space-6xl, 96px); - margin-block-end: var(--rh-space-2xl, 32px); } /* TODO: get rid of inline style/link/script tags inside of container @@ -101,9 +100,8 @@ /* 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); - margin-block-end: var(--rh-space-2xl, 32px); } /* @@ -117,7 +115,6 @@ /* if a section landmark is used */ .container > section > :where(uxdot-copy-permalink.h4, h4) { margin-block-start: var(--rh-space-3xl, 48px); - margin-block-end: var(--rh-space-lg, 16px); } @container main (min-width: 576px) { diff --git a/docs/styles/styles.css b/docs/styles/styles.css index 123318648b..429a571bf7 100644 --- a/docs/styles/styles.css +++ b/docs/styles/styles.css @@ -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) { diff --git a/docs/support/index.md b/docs/support/index.md index 0d25fcfe12..355f46bae6 100644 --- a/docs/support/index.md +++ b/docs/support/index.md @@ -1,6 +1,6 @@ --- layout: layouts/pages/basic.njk -title: Get Support +title: Get support hasToc: false tags: - support @@ -51,14 +51,14 @@ The best way to get help or feedback is through GitHub. This allows us to pull y ### Documentation and Figma help
    - -

    Send documentation feedback

    - If you have general feedback about content on ux.redhat.com, start a discussion. -

    Report a bug on ux.redhat.com

    Submit an issue to fix bugs, like 404s, on ux.redhat.com.
    + +

    Send documentation feedback

    + If you have general feedback about content on ux.redhat.com, start a discussion. +

    Submit design library feedback

    Create a discussion to request new features or fixes for the Red Hat Design System’s Figma library. @@ -78,14 +78,12 @@ The best way to get help or feedback is through GitHub. This allows us to pull y

    Join office hours Internal Red Hat users only

    The Red Hat Design System team holds office hours weekly. The meeting time and link are in our #red-hat-design-system Slack channel bookmarks.

    +
    +

    Email us

    +

    Send a message to design-system@redhat.com.

    +
    - -### Email us - -Send a message to design-system@redhat.com. - -