Skip to content
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

[docs] apply the "feedback" docs component to all pages #1117

Closed
heyMP opened this issue Jul 5, 2023 · 0 comments · Fixed by #1129
Closed

[docs] apply the "feedback" docs component to all pages #1117

heyMP opened this issue Jul 5, 2023 · 0 comments · Fixed by #1129
Assignees
Labels
docs Improvements or additions to documentation feature New feature or request

Comments

@heyMP
Copy link
Member

heyMP commented Jul 5, 2023

Description

We currently handle the "feedback" section in two ways.

  1. We have feedback component (docs/_includes/feedback.html) that is handles the feedback footer for all elements & patterns pages.

docs/elements/elements.html

 {% include 'feedback.html' %}
  1. We add a block of HTML to each page that contains some classes and formatting for re-creating the feedback section.

docs/release-notes.njk

<div class="multi-column--min-300-wide section section--palette-default container feedback">
  <div>
    {% call getstarted.section("Feedback") -%}
      <p>To give feedback about anything on this page, <a href="mailto:[email protected]">contact us</a>.</p>
    {%- endcall %}
  </div>
  <div>
    {% call getstarted.section("Other libraries") -%}
      <p>To learn more about our other libraries, visit <a href="../../get-started">this page</a>.</p>
    {%- endcall %}
  </div>
</div>

Suggested solution

We should improve the feedback component logic so that it can work beyond the elements & patterns pages.

Example API

No response

Additional context

No response

@heyMP heyMP added feature New feature or request docs Improvements or additions to documentation labels Jul 5, 2023
@heyMP heyMP mentioned this issue Jul 5, 2023
6 tasks
@bennypowers bennypowers added this to the RHDS Bulbasaur milestone Jul 5, 2023
@bennypowers bennypowers self-assigned this Jul 6, 2023
bennypowers added a commit that referenced this issue Jul 6, 2023
bennypowers added a commit that referenced this issue Sep 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation feature New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants