docs: Added "ask a question" to side panel of each doc #5681
Conversation
Signed-off-by: melsal13 <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5681 +/- ##
==========================================
+ Coverage 65.23% 65.27% +0.03%
==========================================
Files 213 213
Lines 34108 34108
==========================================
+ Hits 22251 22264 +13
+ Misses 10515 10505 -10
+ Partials 1342 1339 -3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| @@ -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> | |||
There was a problem hiding this comment.
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
There was a problem hiding this comment.
@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
There was a problem hiding this comment.
Haha, that makes sense. Thanks!
Ask a question button located under Print entire section button in the right side panel. |
|
hey @melsal13 is this PR ready for review ? |
|
@arkodg Yup! Just changed the stage to ready for review. |
What type of PR is this?
Docs change, added "ask a quesition" button to side panel of docs that links to Envoy gateway github discussions page.
What this PR does / why we need it:
Improves visibility of the github discussion forum.
Which issue(s) this PR fixes:
N/a
Release Notes: No