Skip to content

docs: Added "ask a question" to side panel of each doc #5681

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Apr 10, 2025
Merged

docs: Added "ask a question" to side panel of each doc #5681

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
84a081b
added ask a question to side panel of each doc
melsal13 Apr 7, 2025
4f175f9
Merge branch 'main' into docs-ask-question
melsal13 Apr 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions site/layouts/partials/page-meta-links.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,6 @@
{{ with .CurrentSection.AlternativeOutputFormats.Get "print" -}}
<a id="print" href="{{ .RelPermalink | safeURL }}"><i class="fa-solid fa-print fa-fw"></i> {{ T "print_entire_section" }}</a>
{{ end }}
<a href="https://github.com/envoyproxy/gateway/discussions/new?category=q-a" class="td-page-meta--ask td-page-meta__ask" target="_blank" rel="noopener"><i class="fa-solid fa-question-circle fa-fw"></i> Ask a Question</a>
Copy link
Member

Choose a reason for hiding this comment

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

I'd perfer to guide users to the gateway-user slack channel, as handling questions across multiple platforms can be difficult to manage.

https://envoyproxy.slack.com/archives/C03E6NHLESV

WDYT @envoyproxy/gateway-maintainers

Copy link
Contributor

@missBerg missBerg Apr 8, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

@zhaohuabing i requested this because questions added to GitHub Q&A are:

  • indexed by search engines and helps other people find answers (when for example Googling)
  • accessible to people who are not using slack, I met a lot of people at KubeCon in London who prefer to ask questions outside of Slack

Negatives of Slack questions:

  • not searchable outside of slack
  • not ability to mark an answers as the correct answer to the question
  • not easily integrating directly to GitHub issues

Copy link
Member

Choose a reason for hiding this comment

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

Haha, that makes sense. Thanks!

</div>
{{ end -}}