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

Enabling feedback mechanism for doc pages #930

Merged
merged 7 commits into from
Nov 7, 2023

Conversation

jasonviviano
Copy link
Contributor

@jasonviviano jasonviviano commented Nov 6, 2023

Thank you for helping make the Radius documentation better!

Please follow this checklist before submitting:

  • Read the contribution guide
  • Commands include options for Linux, MacOS, and Windows within codetabs
  • New file and folder names are globally unique
  • Page references use shortcodes instead of markdown or URL links
  • Images use HTML style and have alternative text
  • Places where multiple code/command options are given have codetabs

In addition, please fill out the following to help reviewers understand this pull request:

Description

Adds feedback mechanism for individual pages.

Auto-generated description

🤖 Generated by Copilot at a4c6bd6

Summary

📝🎨📊

This pull request adds a feedback UI component to the documentation site that allows users to rate each page as helpful or not. It modifies the config.toml file and adds a new template file feedback.html to implement the feature.

Feedback UI added
config.toml defines it
Autumn leaves fall fast

Walkthrough

  • Add a feedback UI component to the end of each page (link, link)
  • Define feedback parameters in config.toml file, such as enable flag and messages (link)
  • Create a partial template feedback.html that renders the feedback buttons and messages using the parameters (link)
  • Include CSS styles and a script in feedback.html that handle the button clicks, hide the buttons, and send feedback data to Google Analytics (link)

Issue reference

#929

@jasonviviano jasonviviano requested review from a team as code owners November 6, 2023 17:21
@jasonviviano jasonviviano changed the title Adding Feedback mechanism that Dapr docs use Enabling Feedback mechanism for doc pages Nov 6, 2023
@jasonviviano jasonviviano changed the title Enabling Feedback mechanism for doc pages Enabling feedback mechanism for doc pages Nov 6, 2023
@jasonviviano jasonviviano force-pushed the jasonviviano/feedback-component branch from a4c6bd6 to da0d028 Compare November 6, 2023 18:55
@jasonviviano jasonviviano enabled auto-merge (squash) November 6, 2023 19:02
docs/config.toml Outdated Show resolved Hide resolved
docs/config.toml Outdated Show resolved Hide resolved
docs/config.toml Outdated Show resolved Hide resolved
docs/config.toml Outdated Show resolved Hide resolved
docs/config.toml Outdated Show resolved Hide resolved
Signed-off-by: jasonviviano <[email protected]>
docs/config.toml Outdated Show resolved Hide resolved
Signed-off-by: jasonviviano <[email protected]>
docs/config.toml Outdated Show resolved Hide resolved
Co-authored-by: Aaron Crawfis <[email protected]>
Signed-off-by: jasonviviano <[email protected]>
@jasonviviano jasonviviano merged commit 55fb874 into edge Nov 7, 2023
8 of 9 checks passed
@jasonviviano jasonviviano deleted the jasonviviano/feedback-component branch November 7, 2023 19:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants