Skip to content

Conversation

@stumbo
Copy link
Member

@stumbo stumbo commented Feb 4, 2024

This change takes advantage of existing Docsy infrastructure. I have enabled the feedback dialog which is put at the bottom of each page:
image

If either the yes or no button is pushed the user is given an opportunity to provide additional feedback:

image

The above represents when the user selects No. The link takes the user to our standard Documentation Issue Submission Form on GitHub:

image


We can start with this approach. One advantage, the documentation states that when the Yes or No button is pushed an event is sent to Google Analytics. This may start giving us some additional feedback on pages regardless of whether the user takes the next step to create an issue:

# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
# If you want this feature, but occasionally need to remove the "Feedback" section from a single page, ...

@stumbo stumbo marked this pull request as ready for review February 4, 2024 23:42
Copy link
Contributor

@pamoroso pamoroso left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks good to me and this Docsy feature seems a great tool.

@masinter masinter merged commit c379385 into main Feb 5, 2024
@masinter masinter deleted the submitIssue branch February 5, 2024 18:15
@masinter
Copy link
Member

Do you need a GitHub account to raise an issue ?

@pamoroso
Copy link
Contributor

Yes, raising a GitHub issue does require an account.

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.

4 participants