Page MenuHomePhabricator

Document how to use the WDQS/Sparkle in Deploy
Closed, ResolvedPublic

Description

Current Situation:

  • WBS Deploy ships WDQS
  • We have no documentation about using this WDQS

Goal:

  • Reference existing documentation for things not specific to WBS Deploy (e.g. WDQS, SPARQL)
  • For what remains, document how to use WDQS in the WBS Deploy context
    • Through the WDQS frontend - this is trivial
    • Via HTTP
      • Where is the actual endpoint / url
      • Which HTTP methods are support/blocked by WDQS Proxy
      • Is there Authentication in any way?

Acceptance Criteria:

  • Users have a documentation on how to interact with the SPARQL endpoint of a WBS Suite instance put up with WBS Deploy. This should cover all aspects mentioned on Goal

[optional] Notes:

[optional] Open Questions:

Event Timeline

roti_WMDE renamed this task from How to reach the SPARQL endpoint in example to Document how to use the SPARQL endpoint in example.May 27 2024, 11:15 AM
roti_WMDE removed roti_WMDE as the assignee of this task.
roti_WMDE added a project: Documentation.

I may not understand exactly what you are thinking of here so here a couple of questions for my understanding:

  • How is the use of the SPARQL endpoint in a wikibase suite different?
  • What is exactly what you think needs documentation that is not covered in the Wikidata_Query_Service/User_Manual ?
roti_WMDE updated the task description. (Show Details)

I may not understand exactly what you are thinking of here so here a couple of questions for my understanding:

  • How is the use of the SPARQL endpoint in a wikibase suite different?
  • What is exactly what you think needs documentation that is not covered in the Wikidata_Query_Service/User_Manual ?

Updated the task description.

this is out of scope and a ticket exists for it. just noting this is related work:

from brainstorm w loren: consider example queries as part of solving this use-case. to that end, perhaps including an example query to find all existing items would be useful for new users.

note: the key to making this task worthwhile is time-boxing our investment.

consider: a similarly scoped investment for quick statements.

lojo_wmde renamed this task from Document how to use the SPARQL endpoint in example to Document how to use the WDQS/Sparkle in Deploy.Jul 10 2024, 10:58 AM

(...)
from brainstorm w loren: consider example queries as part of solving this use-case. to that end, perhaps including an example query to find all existing items would be useful for new users.

the related tickets (see description) are exactly in this realm

adee_wmde changed the task status from Open to In Progress.Oct 1 2024, 2:02 PM
adee_wmde moved this task from Sprint Backlog to Doing on the Wikibase Suite Team (Sprint-∞) board.