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

Add initial integration for questions & answers in relevant pages #4419

Closed

Conversation

Calinou
Copy link
Member

@Calinou Calinou commented Dec 1, 2020

Alpine.js is used on the frontend.

The backend is a static REST API generated by https://github.com/Calinou/godot-qa-api-generator.

Pages should have a .. questions-answers:: tag1 tag2 directive at the bottom when relevant. I've edited some pages to add such tags, but we should probably go over all pages in a future PR.

The API should allow CORS requests (*) since the JSON files will be hosted on a different domain (docs.godotengine.org/godot.readthedocs.io to godotengine.org).

Questions are sorted by popularity (highest score first) and the top 10 questions are displayed on relevant pages. The "(from Godot Q&A)"* link can be clicked to view all questions.

This closes godotengine/godot-proposals#481.

Preview

Light theme

Q&A integration

Dark theme

Q&A integration

@Calinou Calinou force-pushed the add-questions-answers-integration branch 2 times, most recently from 84f8a24 to 762f220 Compare December 1, 2020 22:54
@Calinou Calinou force-pushed the add-questions-answers-integration branch from 762f220 to 5a75e75 Compare December 13, 2020 14:39
@Calinou Calinou force-pushed the add-questions-answers-integration branch from 5a75e75 to 90c3fb4 Compare December 21, 2020 17:48
@Calinou Calinou force-pushed the add-questions-answers-integration branch 3 times, most recently from 9429513 to f29c7f2 Compare January 27, 2021 17:35
- Alpine.js is used on the frontend.
- The backend is a static REST API generated by
  <https://github.com/Calinou/godot-qa-api-generator>.
@Calinou Calinou force-pushed the add-questions-answers-integration branch from f29c7f2 to 8c9b69e Compare January 27, 2021 17:55
@akien-mga akien-mga self-requested a review March 19, 2021 12:50
@seppoday
Copy link

Will we merge this soonish?

@Calinou
Copy link
Member Author

Calinou commented Aug 13, 2022

Will we merge this soonish?

reduz wanted to do this differently (with an invisible tag per page), so probably not. For this to work, the Q&A website would have to be modified to hide tags that start with a specific prefix.

The other issue is that we're not 100% sure if we want to continue using Question2Answer in the future, as it's no longer really maintained upstream. There are a lot of unresolved spam and performance issues with it, which platforms like GitHub Discussions don't have.

@skyace65 skyace65 added content:website Issues related to adding website features and fixing bugs, whether on the front or back-end area:manual Issues and PRs related to the Manual/Tutorials section of the documentation labels Jan 13, 2023
@Calinou
Copy link
Member Author

Calinou commented Jun 15, 2023

Unlike this PR, the approach linked above doesn't rely on the slow Question2Answer backend and doesn't require hosting a dedicated service to expose a REST API. It also goes for a php.net-style "user notes" as opposed to questions & answers. User notes displayed at the bottom of a manual or class reference page are usually more suited to bring clarifications, rather than asking support questions.

@Calinou Calinou closed this Jun 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
archived area:manual Issues and PRs related to the Manual/Tutorials section of the documentation content:website Issues related to adding website features and fixing bugs, whether on the front or back-end enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Embed QA into documentation pages
3 participants