holoviz/panel

Document REST API functionality

Open

#2,867 opened on Oct 30, 2021

View on GitHub
 (3 comments) (1 reaction) (0 assignees)Python (615 forks)auto 404
good first issuetype: docstype: enhancement

Repository metrics

Stars
 (5,722 stars)
PR merge metrics
 (PR metrics pending)

Description

It's been possible to build powerful REST Apis with Panel since v. 0.10 https://blog.holoviz.org/panel_0.10.0.html#REST-APIs. But looking through the documentation at https://panel.holoviz.org I simply cannot see this introduced or showcased. I think its pretty powerful.

Solution

Add documentation.

image

Contributor guide

Research direction
Examine the Panel v0.10 release blog post and source code to identify REST API features, then create a documentation page in the Panel documentation site.
Tech stack
python
Domain
backenddocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonPanel
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80