[GitHub] [druid] 317brian opened a new issue, #13239: docs: update the layout/organization of the API reference

[GitBox <gi...@apache.org>]

317brian opened a new issue, #13239:
URL: https://github.com/apache/druid/issues/13239

   ### Description
   
   Suggested updates to https://druid.apache.org/docs/latest/operations/api-reference.html
   
   Some cleanup was started in this PR: https://github.com/apache/druid/pull/13213
   
   This issue is to track other changes that have been requested:
   
   * The single page, as it exists now, is cumbersome to use. We can break it up (using the current headings as a guide).
   * The API reference should be more prominent/visible in the nav. It's currently a subitem in the Operations category.
   * Not all the REST APIs are on the API reference page. We should collect them into one place for better UX.
   
   A stretch goal would be to adopt the form factor that the API pages for SQL-based ingestion uses: https://druid.apache.org/docs/latest/multi-stage-query/api.html after the 3 bullet points are addressed. 
   
   ### Motivation
   
   The current form factor of the API reference page is not great for users, especially newer ones. We should improve it since developer facing docs are a priority.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org